Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Query Parameters

limit
integer
default:10

The number of items to return

Required range: 1 <= x <= 100
offset
integer
default:0

How many items to skip (use in conjunction with limit for pagination)

Required range: x >= 0
projectId
string

Filter by project id

datasourceId
string

Filter by Data Source

trackingKey
string

Filter by experiment tracking key

experimentId
string
deprecated

Filter the returned list by the experiment tracking key (not the internal experiment ID). Note, this was deprecated to help reduce confusion, consider using trackingKey instead, which is functionally identical. You cannot use both params at the same time.

status
enum<string>
Available options:
draft,
running,
stopped
q
string

Raw experiment search/filter string (same syntax as the app's experiment list filters, e.g. status:running tag:checkout). Negation (!) and operators (~, ^, >, <, =) are not supported and return a 400

owner
string

Filter by comma-separated owner ids, names, or emails

result
enum<string>[]

Filter by comma-separated results (won, lost, inconclusive, dnf). Matches the experiment's recorded result — set when an experiment is stopped and retained if it's later restarted, so running experiments can match too

Available options:
dnf,
won,
lost,
inconclusive
tag
string

Filter by comma-separated tags

implementationType
enum<string>[]

Filter by comma-separated implementation types (feature, visualChange, redirect) — the kinds of changes linked to the experiment. To filter standard experiments vs bandits, use bandits instead

Available options:
feature,
visualChange,
redirect
metricId
string

Filter by comma-separated metric ids. Matches experiments that use a metric as a goal, secondary, or guardrail metric

bandits
enum<string>

When true, return only multi-armed bandits; when false, exclude them

Available options:
true,
false
archived

Filter by archived status. Set to true to return only archived experiments, false to exclude them. If omitted, both archived and non-archived experiments are returned.

Allowed value: "true"
sortBy
enum<string>
default:dateCreated

Field to sort the results by

Available options:
dateCreated,
dateUpdated,
name
sortOrder
enum<string>
default:asc

Sort direction (used with sortBy)

Available options:
asc,
desc

Response

200 - application/json

Successful response

experiments
object[]
required
limit
integer
required
offset
integer
required
count
integer
required
total
integer
required
hasMore
boolean
required
nextOffset
integer | null
required