Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns child Properties under the specified parent Account.
Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/properties
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
filter |
string
Required. An expression for filtering the results of the request. Fields eligible for filtering are: parent:(The resource name of the parent account/property) or ancestor:(The resource name of the parent account) or firebase_project:(The id or number of the linked firebase project). Some examples of filters:
| Filter | Description |
|-----------------------------|-------------------------------------------|
| parent:accounts/123 | The account with account id: 123. |
| parent:properties/123 | The property with property id: 123. |
| ancestor:accounts/123 | The account with account id: 123. |
| firebase_project:project-id | The firebase project with id: project-id. |
| firebase_project:123 | The firebase project with number: 123. |
|
pageSize |
integer
The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
|
pageToken |
string
A page token, received from a previous properties.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to properties.list must match the call that provided the page token.
|
showDeleted |
boolean
Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.
|
Request body
The request body must be empty.
Response body
Response message for properties.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"properties": [
{
object (Property)
}
],
"nextPageToken": string
} |
| Fields |
properties[] |
object (Property)
Results that matched the filter criteria and were accessible to the caller.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/analytics.readonlyhttps://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eLists all Google Analytics 4 properties under a specified parent account, excluding soft-deleted properties by default.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by parent account, ancestor account, or linked Firebase project using the \u003ccode\u003efilter\u003c/code\u003e query parameter.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scopes.\u003c/p\u003e\n"],["\u003cp\u003eReturns an empty list if no matching properties are found or if the user lacks access.\u003c/p\u003e\n"]]],["This describes how to list child properties under a parent account using a `GET` request to `https://analyticsadmin.googleapis.com/v1alpha/properties`. The request requires a filter parameter to specify the parent. Additional optional query parameters include `pageSize`, `pageToken`, and `showDeleted`. The request body must be empty. A successful response includes a list of `properties` and a `nextPageToken` for pagination. Authorization requires `analytics.readonly` or `analytics.edit` scopes.\n"],null,["# Method: properties.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListPropertiesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns child Properties under the specified parent Account.\n\nProperties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/properties`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | |\n| `pageSize` | `integer` The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) |\n| `pageToken` | `string` A page token, received from a previous `properties.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `properties.list` must match the call that provided the page token. |\n| `showDeleted` | `boolean` Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for properties.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"properties\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `properties[]` | `object (`[Property](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#Property)`)` Results that matched the filter criteria and were accessible to the caller. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]
