Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
Method: properties.customDimensions.get
Stay organized with collections
Save and categorize content based on your preferences.
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.readonlyhttps://www.googleapis.com/auth/analytics.edit
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eThis page details how to use the Google Analytics Admin API to look up a single custom dimension.\u003c/p\u003e\n"],["\u003cp\u003eRequests must use the \u003ccode\u003eGET\u003c/code\u003e method and provide the \u003ccode\u003ename\u003c/code\u003e of the custom dimension in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eNo request body is needed, and a successful response returns a \u003ccode\u003eCustomDimension\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required with either \u003ccode\u003eanalytics.readonly\u003c/code\u003e or \u003ccode\u003eanalytics.edit\u003c/code\u003e scopes.\u003c/p\u003e\n"]]],["To retrieve a CustomDimension, use a `GET` request to the specified URL, including the dimension's `name` in the path. The `name` parameter is required and follows the format `properties/*/customDimensions/*`. The request body should be empty. A successful response returns a `CustomDimension` instance. This action requires authorization via either the `analytics.readonly` or `analytics.edit` OAuth scopes. The URL format uses gRPC Transcoding syntax.\n"],null,["# Method: properties.customDimensions.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLookup for a single CustomDimension.\n\n### HTTP request\n\n`GET https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*/customDimensions/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [CustomDimension](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customDimensions#CustomDimension).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/analytics.readonly`\n- `https://www.googleapis.com/auth/analytics.edit`"]]
