Method: properties.customDimensions.get

  • This document details how to look up a single CustomDimension using the Google Analytics Admin API.

  • It requires a GET request to a specific URL with the CustomDimension's name as a path parameter.

  • The request body should be empty, and a successful response returns a CustomDimension object.

  • Authorization is required with either read-only or edit access scopes for Google Analytics.

Lookup for a single CustomDimension.

HTTP request

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