Docs powered by Archbee

Model: CompoundSubMetric

1 min

Model Parameters

CompoundSubMetric
- aggregatorstring<unique | count | sum>
  Description
  The aggregation function for the numerator of the metric. 'unique' measures the number of unique visitors/sessions that include the specified Event. 'count' measures the total number of occurrences of Event for the scope (visitor/session). 'sum' is the sum of the 'field' value.
  Default
  unique
  Allowed
  uniquecountsum
- event_idinteger<int64>
  Description
  The ID for the Event to select data from.
  Format
  int64
- event_typestring<custom | click | pageview>
  Description
  The type of this Event.
  Allowed
  customclickpageview
- fieldstring<revenue | value>
  Description
  The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted.
  Allowed
  revenuevalue
- scopestring<session | visitor | event>
  Description
  Specifies how Events should be grouped. Can also be thought of as the denominator of the metric. 'session' divides by the number of sessions. "Influenced sessions", or sessions that do not contain a decision Event but carry a decision from a previous session are not included in counts for numerator or denominator. 'visitor' divides by the number of visitors. 'event' divides by the total occurrences (impressions) of the specified Event.
  Default
  visitor
  Allowed
  sessionvisitorevent

A metric that is used only as part of the calculation for a ratio metric.

Docs powered by Archbee