Metric
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 .
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-09 UTC.
[null,null,["Last updated 2024-10-09 UTC."],[[["Metrics quantify report data, such as the total events with `eventCount`."],["You can request up to 10 metrics in a report."],["Metrics are defined by `name`, `expression` for calculations, and `invisible` to control visibility."],["`name` can be a standard metric or a custom name when `expression` is used."],["`expression` enables creating calculated metrics like \"Event count per user\" (`eventCount/totalUsers`)."]]],[]]