Method: properties.calculatedMetrics.list

  • The endpoint lists CalculatedMetrics on a property using a GET request to a specified URL.

  • The request requires a parent path parameter specifying the property.

  • Optional query parameters include pageSize for limiting results and pageToken for pagination.

  • The request body must be empty, while the response body contains a list of calculatedMetrics and an optional nextPageToken.

  • Authorization requires either the analytics.readonly or analytics.edit OAuth scope.

Lists CalculatedMetrics on a property.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{parent=properties/*}/calculatedMetrics

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Example format: properties/1234

Query parameters

Parameters
pageSize

integer

Optional. 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

Optional. A page token, received from a previous calculatedMetrics.list call. Provide this to retrieve the subsequent page.

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

Request body

The request body must be empty.

Response body

Response message for calculatedMetrics.list RPC.

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

JSON representation 
{
  "calculatedMetrics": [
    {
      object (CalculatedMetric)
    }
  ],
  "nextPageToken": string
}
Fields
calculatedMetrics[]

object (CalculatedMetric)

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