Struct Metric

pub struct Metric {
    pub expression: Option<String>,
    pub invisible: Option<bool>,
    pub name: Option<String>,
}

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

This type is not used in any activity, and only used as part of another schema.

Fields

expression: Option<String>

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

invisible: Option<bool>

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.

name: Option<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.

Trait Implementations

impl Clone for Metric

fn clone(&self) -> Metric

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Metric

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Metric

fn default() -> Metric

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Metric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Metric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for Metric