Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: accountSummaries.list
Stay organized with collections
Save and categorize content based on your preferences.
Returns summaries of all accounts accessible by the caller.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/accountSummaries
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters |
pageSize |
integer
The maximum number of AccountSummary 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 accountSummaries.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to accountSummaries.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for accountSummaries.list RPC.
If successful, the response body contains data with the following structure:
JSON representation |
{
"accountSummaries": [
{
object (AccountSummary )
}
],
"nextPageToken": string
} |
Fields |
accountSummaries[] |
object (AccountSummary )
Account summaries of all accounts the caller has access to.
|
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.readonly
https://www.googleapis.com/auth/analytics.edit
AccountSummary
A virtual resource representing an overview of an account and all its child Google Analytics properties.
JSON representation |
{
"name": string,
"account": string,
"displayName": string,
"propertySummaries": [
{
object (PropertySummary )
}
]
} |
Fields |
name |
string
Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"
|
account |
string
Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"
|
displayName |
string
Display name for the account referred to in this account summary.
|
propertySummaries[] |
object (PropertySummary )
List of summaries for child accounts of this account.
|
PropertySummary
A virtual resource representing metadata for a Google Analytics property.
JSON representation |
{
"property": string,
"displayName": string,
"propertyType": enum (PropertyType ),
"parent": string
} |
Fields |
property |
string
Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"
|
displayName |
string
Display name for the property referred to in this property summary.
|
propertyType |
enum (PropertyType )
The property's property type.
|
parent |
string
Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200"
|
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 and summarizes all Google Analytics 4 (GA4) accounts and their properties accessible to the authenticated user.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to handle large numbers of accounts using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eEach account summary includes the account name, display name, and a list of associated property summaries.\u003c/p\u003e\n"],["\u003cp\u003eProvides property details such as property name, display name, type, and its parent resource.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for access, including 'analytics.readonly' or 'analytics.edit'.\u003c/p\u003e\n"]]],["This document details how to retrieve summaries of accessible Google Analytics accounts via an HTTP GET request to `https://analyticsadmin.googleapis.com/v1alpha/accountSummaries`. Key actions include setting optional `pageSize` and `pageToken` query parameters for pagination. The request body is empty. The response provides a list of `accountSummaries`, each containing account details and `propertySummaries`, with the possibility of a `nextPageToken` for subsequent pages. Authorization requires specific OAuth scopes.\n"],null,["# Method: accountSummaries.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.ListAccountSummariesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [AccountSummary](#AccountSummary)\n - [JSON representation](#AccountSummary.SCHEMA_REPRESENTATION)\n- [PropertySummary](#PropertySummary)\n - [JSON representation](#PropertySummary.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nReturns summaries of all accounts accessible by the caller.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/accountSummaries`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of AccountSummary 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 `accountSummaries.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `accountSummaries.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for accountSummaries.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accountSummaries\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/accountSummaries/list#AccountSummary) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountSummaries[]` | `object (`[AccountSummary](/analytics/devguides/config/admin/v1/rest/v1alpha/accountSummaries/list#AccountSummary)`)` Account summaries of all accounts the caller has access to. |\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`\n\nAccountSummary\n--------------\n\nA virtual resource representing an overview of an account and all its child Google Analytics properties.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"account\": string, \"displayName\": string, \"propertySummaries\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/accountSummaries/list#PropertySummary) } ] } ``` |\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\" |\n| `account` | `string` Resource name of account referred to by this account summary Format: accounts/{account_id} Example: \"accounts/1000\" |\n| `displayName` | `string` Display name for the account referred to in this account summary. |\n| `propertySummaries[]` | `object (`[PropertySummary](/analytics/devguides/config/admin/v1/rest/v1alpha/accountSummaries/list#PropertySummary)`)` List of summaries for child accounts of this account. |\n\nPropertySummary\n---------------\n\nA virtual resource representing metadata for a Google Analytics property.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"property\": string, \"displayName\": string, \"propertyType\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties#PropertyType), \"parent\": string } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `property` | `string` Resource name of property referred to by this property summary Format: properties/{property_id} Example: \"properties/1000\" |\n| `displayName` | `string` Display name for the property referred to in this property summary. |\n| `propertyType` | `enum (`[PropertyType](/analytics/devguides/config/admin/v1/rest/v1alpha/properties#PropertyType)`)` The property's property type. |\n| `parent` | `string` Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\", \"properties/200\" |"]]