Method: properties.customMetrics.get

  • Retrieves a single, user-defined metric (CustomMetric) for analysis within a Google Analytics 4 property.

  • Requires specifying the complete resource name of the CustomMetric in the request path.

  • The response provides comprehensive details about the requested CustomMetric if authorized with appropriate scopes.

  • Allows read-only or edit access to the requested metric based on the provided authorization scope.

Lookup for a single CustomMetric.

HTTP request

GET https://analyticsadmin.googleapis.com/v1beta/{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