Skip to main content

Experiment Main Metrics DATA

POST 
/experiments/:experimentId/metrics/main

Required Permissions: Experiment Get or Experiment Admin

Request​

Path Parameters

    experimentId int64required

    Possible values: >= 1

    The id of the experiment that you want the main metrics of.

Body

required

The parameters to filter the main metrics by. If no filtering is required then filters can be an empty object

    filters object
    segments object[]
  • Array [
    • segment_id int64

    Possible values: >= 1

    operator string

    Possible values: [in, not_in]

    values string[]
  • ]

Responses​

A JSON Object with the current values of the experiment's main metrics. The object has three properties, columnNames, columnTypes and rows. columnNames is an array of strings which identifies which columns are which in the rows[][]. columnTypes is an array of strings which identifies the types of data in the rows[][]. rows is an array of arrays which contain the current main metric data for each of the experiment's variants. The column names are defined as the following:

Regular Columns:​

  • variant - The variant that this row describes. (0, 1, 2 or 3).
  • first_exposure_at - The date of the first exposure of this variant in milliseconds since epoch.
  • last_exposure_at - The date of the last exposure of this variant in milliseconds since epoch.
  • unit_count - The number of units that have been exposed to this variant.

Dynamic Columns:​

  • metric_${metric_id} - The current value of the metric with the id of ${metric_id}.
  • metric_${metric_id}_mean - The mean value of the metric with the id of ${metric_id}.
  • metric_${metric_id}_var - The variance of the metric with the id of ${metric_id}.
  • metric_${metric_id}_pvalue - The p-value of the metric with the id of ${metric_id}.
  • metric_${metric_id}_impact - The current impact of the metric with the id of ${metric_id}.
  • metric_${metric_id}_impact_ci_lower - The lower bound of the confidence interval of the impact of the metric with the id of ${metric_id}.
  • metric_${metric_id}_impact_ci_upper - The upper bound of the confidence interval of the impact of the metric with the id of ${metric_id}.
caution

The columns may come in a different order than the one listed above. It's important to use the columnNames array to identify the index of the column you want to use.

Schema
    columnNames string[]
    columnTypes string[]
    rows array[]
Loading...