Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and deletions may occur.
HTTP request
GET https://analyticsdata.googleapis.com/v1alpha/{name}
Required. The name of the metadata to retrieve. Either has the form 'metadata' or 'properties/{property}/metadata'. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics App + Web Property Id.
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Metadata.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-09 UTC."],[[["\u003cp\u003eRetrieves metadata for dimensions and metrics available in reporting methods for exploring data.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using an HTTP GET method to a specific URL with the metadata name.\u003c/p\u003e\n"],["\u003cp\u003eThe response, if successful, contains an instance of \u003ccode\u003eMetadata\u003c/code\u003e object providing the requested information.\u003c/p\u003e\n"],["\u003cp\u003eRequires specific authorization scopes for accessing and retrieving the metadata.\u003c/p\u003e\n"]]],["The core content describes retrieving metadata for dimensions and metrics in Google Analytics reporting methods. A `GET` HTTP request to `https://analyticsdata.googleapis.com/v1alpha/{name}` is used, where `{name}` (a string) is a required path parameter representing the metadata's identifier. The request body must be empty, and a successful response returns a `Metadata` instance. Access requires specific OAuth scopes: `analytics.readonly` or `analytics`. Dimensions and metrics are subject to future additions, renames, or deletions.\n"],null,["# Method: getMetadata\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\nReturns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and deletions may occur.\n\n### HTTP request\n\n`GET https://analyticsdata.googleapis.com/v1alpha/{name}`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the metadata to retrieve. Either has the form 'metadata' or 'properties/{property}/metadata'. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics App + Web Property Id. |\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 [Metadata](/analytics/devguides/reporting/data/v1/rest/v1alpha/Metadata).\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`"]]