Method: properties.customMetrics.list

  • The customMetrics.list method lists CustomMetrics on a property.

  • It uses a GET HTTP request to the specified URL format.

  • The request requires a parent path parameter formatted as properties/*.

  • Optional query parameters include pageSize and pageToken for pagination.

  • The request body should be empty, and the response body contains a list of CustomMetric objects and a nextPageToken.

  • The request requires either the https://www.googleapis.com/auth/analytics.readonly or https://www.googleapis.com/auth/analytics.edit OAuth scope.

Lists CustomMetrics on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1beta/{parent=properties/*}/customMetrics

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 customMetrics.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to customMetrics.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for customMetrics.list RPC.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "customMetrics": [
    {
      object (CustomMetric)
    }
  ],
  "nextPageToken": string
}
Fields
customMetrics[]

object (CustomMetric)

List of CustomMetrics.
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