Method: properties.calculatedMetrics.get

  • This document outlines how to retrieve a single CalculatedMetric using the Google Analytics Admin API.

  • The request involves sending an HTTP GET request to the specified URL with necessary path parameters.

  • No request body is needed for the lookup.

  • Successful requests will return a CalculatedMetric object in the response body.

  • Proper authorization with the specified scopes is required to access this functionality.

Lookup for a single CalculatedMetric.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculatedMetricId} Example: properties/1234/calculatedMetrics/Metric01

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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