Method: properties.customMetrics.get

  • Retrieves a single, specified CustomMetric using its resource name.

  • Requires providing the CustomMetric's name in the request URL path.

  • An empty request body is necessary, and a successful response returns a CustomMetric object.

  • Authorization is required with specific OAuth scopes for either read-only or edit access to Analytics data.

Lookup for a single CustomMetric.

HTTP request

GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customMetrics/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of CustomMetric.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit