Metric

  • Metrics are the quantitative measurements in a report, like the total number of events.

  • Reports can include up to 10 metrics.

  • Metrics have fields for name, expression, and an optional invisible flag.

  • name is used to reference metrics in filters, orderings, and expressions.

  • expression is used to define calculated metrics from other metrics.

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

JSON representation
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Fields
name

string

The name of the metric. See the API Metrics for the list of metric names.

If expression is specified, name can be any string that you would like. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession.

Metrics are referenced by name in metricFilter, orderBys, and metric expression.

expression

string

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

invisible

boolean

Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in metricFilter, orderBys, or a metric expression.