Skip to main content
GET
Retrieve Experiment

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

The experiment identifier — the expt_ id or the flag_key handle.

Paramètres de requête

account_id
string

Owning account ID. Required when id is a flag key; optional for an expt_ ID.

Réponse

experiment found

account_id
string
requis

Owning account ID.

Exemple:

"biz_xxxxxxxxxxxxxx"

assignment_seed
string
requis

Assignment hashes UTF-8 seed + subject ID with CRC32 modulo 100 and selects the stored end-exclusive range.

Exemple:

"checkout_redesign_v21768435200"

configuration_revision
integer
requis

Revision of the serving configuration. Increments on every configuration change, so a cached definition with a lower revision is stale. Does not change the assignment seed.

Exemple:

1

control
object
requis
flag_key
string
requis

Developer-chosen handle referenced from code. Anywhere the API takes an experiment identifier, the expt_ id and the flag_key are interchangeable.

Exemple:

"checkout_redesign_v2"

id
string
requis

Unique identifier for the experiment, prefixed expt_.

Exemple:

"expt_xxxxxxxxxxxxxx"

name
string
requis

Human-readable display name.

Exemple:

"Checkout Redesign V2"

Resource owned by the account that this experiment is bound to, such as an app or product. null when unbound. Fixed once the experiment first activates.

status
enum<string>
requis

Lifecycle state. draft — not yet live; active — currently running; paused — traffic paused; ended — concluded.

Options disponibles:
draft,
active,
paused,
ended
Exemple:

"draft"

updated_at
string<date_time> | null
requis
Exemple:

"2026-01-01T12:00:00.000Z"

variants
object[]
requis

Treatment arms. Users outside every arm's allocation form the implicit control group. Weights only ever grow and arms are never removed, so a user moves from control into a treatment at most once.

bucket_by
enum<string> | null

Randomization unit — user buckets each user independently, account buckets whole accounts (every user of an account gets the same arm). null for feature flags.

Options disponibles:
user,
account,
anonymous
Exemple:

"user"

created_at
string | null

When the experiment was created, as an ISO 8601 timestamp.

Exemple:

"2026-01-01T12:00:00.000Z"

created_by
string | null

ID of the user who created the experiment, prefixed user_. null for experiments created before creators were recorded.

Exemple:

"user_xxxxxxxxxxxxxx"

ended_at
string | null

When the experiment stopped collecting data, as an ISO 8601 timestamp. null while still running.

Exemple:

"2026-01-01T12:00:00.000Z"

findings
string | null

What was learned and why this outcome, recorded when the experiment was ended. null until then.

Exemple:

"Treatment lifted conversion 8%"

hypothesis
string | null

Hypothesis for this experiment. null when none is set, and always null for feature flags.

Exemple:

"Users will convert more"

metadata
object

Key-value pairs attached when the experiment was created. Empty when none were set.

Exemple:
started_at
string | null

When the experiment began collecting data, as an ISO 8601 timestamp. null for drafts.

Exemple:

"2026-01-01T12:00:00.000Z"

winning_arm
string | null

The treatment that won, set when the experiment was ended. Once set, every evaluation returns this arm to every caller regardless of targeting or allocation, and no further exposures are recorded. null means control won — an ended experiment with no winning arm evaluates to control for everyone. Always null for feature flags, which simply evaluate to disabled once ended.

Exemple:

"treatment"