Method: getMetadata

AI-generated Key Takeaways

• Retrieves metadata for dimensions and metrics available in reporting methods for exploring data.

• The request is made using an HTTP GET method to a specific URL with the metadata name.

• The response, if successful, contains an instance of Metadata object providing the requested information.

• Requires specific authorization scopes for accessing and retrieving the metadata.

• HTTP request
• Path parameters
• Request body
• Response body
• Authorization Scopes
• Try it!

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}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
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.

Request body

The request body must be empty.

Response body

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

Authorization Scopes

Requires one of the following OAuth scopes:

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