Model: CampaignMetricResults

1 min

Model Parameters

CampaignMetricResults
- aggregatorstring<unique | count | sum | bounce | exit | ratio>
  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
  Allowed
  uniquecountsumbounceexitratio
- event_idinteger<int64>
  Description
  The ID for the Event to select data from. Omitted for global metrics that are not relative to a specific Event, i.e. "overall revenue"
  Format
  int64
- event_propertiesMetricEventProperties
  Description
  The conditions used to filter the metric on specific event property values.
  - filterMetricFilter
    Description
    The set of event property conditions a conversion must match to be counted toward the metric.
    - combine_operatorstring<and | or>
      Description
      Determines whether all conditions (and) or any condition (or) must be met.
      Allowed
      andor
    - conditionsMetricFilterCondition[]
      Description
      defines the event property values and operator used to check whether the conversion meets the condition.
      - namestring
        Description
        The name of the event property to match to.
      - operatorstring<equal_to | not_equal_to | greater_than | greater_than_or_equal_to | less_than | less_than_or_equal_to | contains | does_not_contain>
        Description
        The type of match to be performed. equal_to and not_equal_to are available for all property types. greater_than, greater_than_or_equal_to, less_than, and less_than_or_equal_to are only available for properties with type number. contains and does_not_contain are only available for properties with type string.
        Allowed
        equal_tonot_equal_togreater_thangreater_than_or_equal_toless_thanless_than_or_equal_tocontainsdoes_not_contain
      - typestring<boolean | number | string>
        Description
        The data type of the event property.
        Allowed
        booleannumberstring
      - valuestring
        Description
        The value the conversion's property should match, according to the operator.
- fieldstring<revenue | value>
  Description
  The field to aggregate for the numerator of the metric. Required when 'aggregator' = 'sum', otherwise omitted
  Allowed
  revenuevalue
- metricsCompoundSubMetric[]
  Description
  A list of all metrics that will be used in the calculation of a ratio metric.
  - 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
- namestring
  Description
  The name of the Metric
- resultsmap<string, VariantResults>
  Description
  A map of results for the variants affected by the Campaign. Variants may represent aggregated results scoped to the Campaign and/or individual Experiment results scoped to just that Experiment. The special variant 'baseline' represents visitors that have been held back from any change in experience across all Experiments in the Campaign. The special variant 'campaign' represents the aggregated effect of all Experiments included in the Campaign.
- scopestring<session | visitor | event>
  Description
  Specifies how Events should be grouped together. Can also be thought of as the denonimator 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
  Allowed
  sessionvisitorevent
- time_windowstring
  Description
  The maximum amount of time a numerator event can differ from a denominator event in order to be included in a ratio metric. This can be an integer, or an integer followed by a letter denoting the unit of time (d = days, h = hours, m = minutes). If no unit of time is supplied, hours is assumed. If no value is supplied, a time window of 48 hours is assumed.
- winning_directionstring<increasing | decreasing>
  Description
  The winning direction of this metric
  Allowed
  increasingdecreasing

Results specific to an Event