Metadata

  • The content describes the metadata for dimensions and metrics accepted in reporting methods.

  • The metadata includes a resource name, a list of dimension descriptions, and a list of metric descriptions.

  • DimensionMetadata provides details like the API name, UI name, description, and deprecated API names for a dimension.

  • MetricMetadata explains a metric with fields for API name, UI name, description, deprecated API names, type, and expression.

The dimensions and metrics currently accepted in reporting methods.

JSON representation 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Fields
name

string

Resource name of this metadata.
dimensions[]

object (DimensionMetadata)

The dimensions descriptions.
metrics[]

object (MetricMetadata)

The metric descriptions.

DimensionMetadata

Explains a dimension.

JSON representation 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ]
}
Fields
apiName

string

This dimension's name. Useable in Dimension's name. For example, eventName.
uiName

string

This dimension's name within the Google Analytics user interface. For example, Event name.
description

string

Description of how this dimension is used and calculated.
deprecatedApiNames[]

string

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName.

MetricMetadata

Explains a metric.

JSON representation 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string
}
Fields
apiName

string

A metric name. Useable in Metric's name. For example, eventCount.
uiName

string

This metric's name within the Google Analytics user interface. For example, Event count.
description

string

Description of how this metric is used and calculated.
deprecatedApiNames[]

string

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.
type

enum (MetricType)

The type of this metric.
expression

string

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.