Sign in
Experiment

Returns all experiments, optionally restricted to one state.

get/campaign/experiments

Query parameters

state'draft' | 'active' | 'paused' | 'completed'

The state to filter by; omit to list every experiment.

Response

OK

idstring required

The unique id of the experiment document.

keystring required

Stable unique identifier; the analysis key is exp:<key>.

descriptionstring required

Human-readable description of the hypothesis.

state'draft' | 'active' | 'paused' | 'completed' required
userEnrollment'perSession' | 'sticky' required
startAtstring date-time nullable

Outside the [startAt, endAt) window the experiment is treated as inactive.

endAtstring date-time nullable

End of the experiment window; the experiment auto-completes afterwards.

createdBystring required

The email of the admin who created the experiment.

createdAtstring date-time required

When the experiment was created.

updatedAtstring date-time required

When the experiment was last changed.

Changes

Changed in 1 of the 7 revisions of this API.1