Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.audiences.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.
HTTP request
GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/audiences
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Example format: properties/1234
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of resources to return. 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 audiences.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to audiences.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for audiences.list RPC.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"audiences": [
{
object (Audience)
}
],
"nextPageToken": string
} |
| Fields |
audiences[] |
object (Audience)
List of Audiences.
|
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 audiences on a Google Analytics 4 property, though audiences created before 2020 may have limited support.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large lists of audiences using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes an array of \u003ccode\u003eAudience\u003c/code\u003e objects and a token for retrieving subsequent pages, if available.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eDefault audiences may not display their filter definitions.\u003c/p\u003e\n"]]],["This API lists Audiences associated with a property using a `GET` request to a specified URL with a required `parent` path parameter. Optional `pageSize` and `pageToken` query parameters handle pagination. The request body must be empty. The response body contains a list of `audiences` and a `nextPageToken` for pagination. It requires specific authorization scopes (`analytics.readonly` or `analytics.edit`). Audiences created before 2020 might not be fully supported.\n"],null,["# Method: properties.audiences.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAudiencesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/audiences`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------|\n| `parent` | `string` Required. Example format: properties/1234 |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of resources to return. 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 `audiences.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `audiences.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 audiences.list RPC.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"audiences\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.audiences#Audience) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `audiences[]` | `object (`[Audience](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.audiences#Audience)`)` List of Audiences. |\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`"]]
