Metric

  • Metrics are quantitative measurements in a report, such as event count.

  • Reports allow for up to 10 metrics.

  • Metrics have a JSON representation including name, expression, and invisible fields.

  • The name field is the metric's name and can be a custom string if an expression is provided.

  • The expression field is for mathematical expressions for derived metrics.

  • The invisible field determines if a metric appears as a column in the report response.

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 supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel Metrics for the list of metric names supported by the runFunnelReport method.

If expression is specified, name can be any string that you would like within the allowed character set. For example if expression is screenPageViews/sessions, you could call that metric's name = viewsPerSession. Metric names that you choose must match the regular expression ^[a-zA-Z0-9_]$.

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.