Sign in

v1

latestOpenAPI 3.0.32026-07-248519153.1 KB

Get experiment metric snapshots

Retrieve the cumulative experiment results captured by the clickhouse:snapshot_experiment_metrics scheduled job. Each snapshot stores the running value of every metric (users, subscribe, conversion_to_subscribe, etc.) for every variant at the moment of capture together with statistical-significance fields (p_value, effect_size, absolute/relative deltas and confidence intervals).

The response groups rows by period_index -> variants[] -> metrics{} by default so it can be plotted directly. Pass format=flat to receive raw ClickHouse rows instead. Use latest=true to fetch only the most recent snapshot. Filter by metric, variant_index, strict_experiment_filter, and the period_from / period_to window when needed.

get/experiments/{id}/snapshots

Path parameters

idinteger required

Experiment ID

Query parameters

'users' | 'started_quiz' | 'paywall_views' | 'initiate_checkout' | 'subscribe' | 'conversion_open_to_start_quiz' | 'conversion_to_complete_registration' | 'conversion_to_initiate_checkout' | 'conversion_to_subscribe' | 'view_to_buy' | 'arpu' | 'arppu'
OR
string[]

Filter by metric name(s). Accepts either a single value, a comma-separated list (metric=users,subscribe) or repeated metric[]= query parameters. Allowed values match available_metrics in the response.

variant_indexinteger

Return snapshots only for the given variant.

strict_experiment_filter0 | 1

1 returns snapshots that excluded users who saw more than one experiment simultaneously; 0 returns the unfiltered series. When omitted both modes are returned.

period_fromstring date-time

Lower bound (inclusive) on snapshot_at.

period_tostring date-time

Upper bound (inclusive) on snapshot_at.

latestboolean

Return only the most recent snapshot for the experiment.

format'grouped' | 'flat'

grouped (default) nests results by period_index -> variants[] -> metrics{}. flat returns one row per metric/variant/snapshot as stored in ClickHouse.

Headers

api_keystring required

API key for authentication

Response

Experiment snapshots retrieved successfully

successinteger
experiment_idinteger
experiment_namestring
experiment_slugstring
available_metricsstring[]

Metrics that the snapshot job records for every experiment.

Example response

{
  "success": 1,
  "experiment_id": 42,
  "experiment_name": "Onboarding wording v3",
  "experiment_slug": "onboarding-wording-v3",
  "snapshots": [
    {
      "period_index": 7,
      "variants": [
        {
          "variant_index": 1,
          "variant_name": "Variant B"
        }
      ]
    }
  ]
}