Method: properties.customDimensions.get

  • This page details how to use the Google Analytics Admin API to look up a single custom dimension.

  • Requests must use the GET method and provide the name of the custom dimension in the URL path.

  • No request body is needed, and a successful response returns a CustomDimension object.

  • Authorization is required with either analytics.readonly or analytics.edit scopes.

Lookup for a single CustomDimension.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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