Skip to main content
GET
Get Experiment Results

Authorizations

Authorization
string
header
required

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.

Scopes

experiment:read
stats:read

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-11-19-2"

Path Parameters

id
string
required

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

Query Parameters

from
string

Start of the reporting window, as an ISO 8601 date or timestamp. Defaults to the experiment's start date.

to
string

End of the reporting window, as an ISO 8601 date or timestamp. Defaults to today.

account_id
string

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

Response

experiment results returned

flag_key
string
required

The experiment's flag_key.

Example:

"pricing_page_change"

name
string
required

Display name.

Example:

"Pricing page change"

status
enum<string>
required

Current lifecycle state.

Available options:
draft,
active,
paused,
ended
Example:

"ended"

conclusion
string | null

One sentence that states what the readings show. null until a reading exists.

Example:

"Gross revenue rose 55.98% against the period before, outside the margin of error."

ended_at
string | null

When the experiment concluded, as an ISO 8601 timestamp. null while still active.

Example:

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

from
string | null

Start of the reporting window, as an ISO 8601 date.

Example:

null

primary_stat
string | null

The metric of the reading the experiment is judged on, one of the metric values in stats.

Example:

"gross_revenue"

started_at
string | null

When the experiment began, as an ISO 8601 timestamp.

Example:

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

stats
object[] | null

One reading per target stat, with the arms it was read on. null when there are none.

to
string | null

End of the reporting window, as an ISO 8601 date.

Example:

null