get
https://{yourinstance}.makaira.io/experiment
Returns a paginated list of experiments. Results are sorted and can be filtered by status, date, and search query.
Returns a paginated list of A/B experiments for the current instance.
Requires the experiment:read, abtesting.read, or personalization.read permission.
Request
GET /experiment
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
_sort | string | No | Field to sort by. Defaults to title. |
_order | string | No | Sort direction: ASC or DESC. Defaults to ASC. |
_start | integer | No | Pagination offset. Defaults to 0. |
_end | integer | No | Maximum number of results to return. Defaults to 24. |
_state | string | No | Filter by state. Accepted values: draft, running, scheduled, done. |
_status | string | No | Filter by status. |
_q | string | No | Filter by title (substring search). |
_start_after | string | No | Filter experiments that start after this date (ISO 8601 or any PHP-parseable date). |
_stop_before | string | No | Filter experiments that stop before this date (ISO 8601 or any PHP-parseable date). |
_type | string | No | Filter by experiment type. Accepted values: ranking_mix, recommendation, frontend, personalization, landingpage. |
_metric | string | No | When provided, includes a maximum_change field for each experiment based on the given metric name. |
Response
Returns a JSON array of experiment objects. The X-Total-Count response header contains the total number of matching experiments.
Response Body
Each item in the response array has the following fields:
| Field | Type | Description |
|---|---|---|
id | integer | Unique experiment ID. |
title | string | Experiment title. |
description | string | Optional description. |
case | string | Experiment type: ranking_mix, recommendation, frontend, personalization, or landingpage. |
type | string | Alias for case. |
status | string | Current status: draft, running, scheduled, or done. |
running | boolean | Whether the experiment is currently running. |
finished | boolean | Whether the experiment has finished. |
startDate | string | Scheduled or actual start date (ISO 8601). |
stopDate | string | Stop date (ISO 8601), if stopped. |
duration | integer | Duration in days. |
segments | integer | Total number of variation segments including the original. |
startingAllowed | boolean | Whether the experiment can be started now. |
readOnly | boolean | Whether the experiment is read-only (only set for finished experiments). |
maximum_change | number | Maximum metric change across variations. Only included when _metric query parameter is provided. |
Example Response
[
{
"id": 1,
"title": "Ranking Mix Test",
"description": "Testing new ranking weights",
"case": "ranking_mix",
"type": "ranking_mix",
"status": "running",
"running": true,
"finished": false,
"startDate": "2026-04-01T00:00:00Z",
"stopDate": null,
"duration": 26,
"segments": 2,
"startingAllowed": false,
"readOnly": false
}
]