Take our developer survey. We want your feedback so we can learn how to improve Google Analytics, and make it an even better tool for you.

Custom Metrics: get

Requires authorization

Get a custom metric to which the user has access. Try it now or see an example.

Request

HTTP request

GET https://www.googleapis.com/analytics/v3/management/accounts/accountId/webproperties/webPropertyId/customMetrics/customMetricId

Parameters

Parameter name Value Description
Path parameters
accountId string Account ID for the custom metric to retrieve.
customMetricId string The ID of the custom metric to retrieve.
webPropertyId string Web property ID for the custom metric to retrieve.

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

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

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a management.customMetric resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

/*
 * Note: This code assumes you have an authorized Analytics service object.
 */

/*
 * This request gets an existing custom metric.
 */
 try {
  CustomMetric = analytics.management().customMetrics()
      .get("123456", "UA-123456-1", "ga:metric2").execute();
} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}

Python

Uses the Python client library.

# Note: This code assumes you have an authorized Analytics service object.

# This request gets an existing custom metric.
try:
  metric = analytics.management().customMetrics().get(
      accountId='123456',
      webPropertyId='UA-123456-1',
      customMetricId='ga:metric2'
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

Try it!

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.