For the complete documentation index, see llms.txt. This page is also available as Markdown.

Experiments

GET /experiments

Returns your experiments and personalizations, newest first by when they were last updated. Start here to find the testId every results endpoint needs.

Parameters

Parameter
Description

status

running, paused, done or review

type

One experiment type, see below

isPersonalization

true to list only personalizations, false to exclude them

page, limit

Page number from 1, and page size from 1 to 100 (default 20)

type accepts PAGE, PRODUCT, SPLIT_URL, PRODUCT_GROUP, PRICE_PLUS, SUBSCRIPTION_TEST, CONTENT, THEME, SHIPPING, PRODUCT_IMAGE, CHECKOUT and CUSTOM_CODE, the same values type carries in the response.

Response

Field
Type
What it holds

items[].testId

string

The ID every other endpoint takes

items[].name

string | null

The experiment's name

items[].type, items[].typeName

string

The type code and its display name

items[].status

string

Running, Paused, Done or In Review

items[].goal

string | null

The metric it is judged on

items[].customEventTrackingId

string | null

Set when the goal is CUSTOM_EVENT

items[].isPersonalization

boolean

Whether it is a personalization

items[].testTrafficPercentage

number | null

Share of visitors entering the experiment

items[].startingAt, completedAt, createdAt, updatedAt

string | null

ISO 8601 timestamps

items[].variations[]

object

id, name, trafficPercentage, isControl

pagination

object

page, limit, total and totalPages as integers, hasNextPage and hasPreviousPage as booleans

Worth knowing

  • Page through with hasNextPage rather than counting pages yourself.

  • Drafts and deleted experiments are never returned, and neither are experiment types the API does not support. Requesting one by ID returns 404.

  • Poll this endpoint, not the results ones, to spot what changed: it is far cheaper than asking for results you already have.

Last updated