Method: properties.audiences.list

  • Lists all audiences on a Google Analytics 4 property, though audiences created before 2020 may have limited support.

  • Allows for pagination to retrieve large lists of audiences using pageSize and pageToken parameters.

  • Response includes an array of Audience objects and a token for retrieving subsequent pages, if available.

  • Requires authorization with either analytics.readonly or analytics.edit scope.

  • Default audiences may not display their filter definitions.

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.readonly
  • https://www.googleapis.com/auth/analytics.edit