analyticsdata.properties.getMetadata
Retrieves available dimensions and metrics metadata for a Google Analytics property, including custom fields and universal metadata, to help explore reporting options.
Instructions
Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name levels_unlocked is registered to a property, the Metadata response will contain customEvent:levels_unlocked. Universal metadata are dimensions and metrics applicable to any property such as country and totalUsers [HTTP GET]. Returns the requested resource as JSON — request bodies are built from the typed parameters (typed flags win over the params map), or read whole from body_file Siblings over the same resource: batchRunPivotReports, batchRunReports, checkCompatibility, runPivotReport, runRealtimeReport, runReport.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | [URL path segment] Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analy | |
| query | No | Extra KEY=VALUE query pairs for endpoints whose parameters Discovery does not describe. | |
| params | No | Parameter map merged into the request; typed parameters win. | |
| dry_run | No | Return the request that would be sent, without sending it. | |
| body_file | No | Read the request body from this file ('-' for stdin) instead of building one from the parameters. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| metrics | No | ||
| dimensions | No | ||
| comparisons | No |