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

Experiment

GET /experiments/{testId}

Returns how one experiment is set up: its variations, what it targets, who it runs for and how it has changed. It holds no results; for those use /summary or /results.

Response

Everything /experiments returns per item, plus:

Field
Type
What it holds

description, hypothesis

string | null

What the experiment is, and what it expects

currency

string | null

The store currency

variations[]

object

As in the list, plus link, previewUrl and splitUrlTargets

targeting

object

productIds, collectionIds, pages and pageTargets

audience

object

filterType and the filters deciding who enters

history[]

object

event, changedFields and createdAt, newest first

curl https://elevateab.app/api/external/v1/experiments/TEST_ID \
  -H "Authorization: Bearer YOUR_API_KEY"
{
  "success": true,
  "data": {
    "testId": "3f2a9c1e-5b7d-4e8a-9f10-2c4d6e8a0b12",
    "name": "Homepage hero",
    "type": "PAGE",
    "status": "Running",
    "goal": "CONVERSION_RATE",
    "testTrafficPercentage": 100,
    "variations": [
      {
        "id": 1001,
        "name": "Control",
        "trafficPercentage": 50,
        "isControl": true
      }
    ],
    "targeting": {
      "productIds": [],
      "collectionIds": [],
      "pages": ["/"],
      "pageTargets": []
    },
    "audience": { "filterType": "all", "filters": [] },
    "history": [
      {
        "event": "Experiment started",
        "changedFields": [],
        "createdAt": "2026-09-01T08:00:00.000Z"
      }
    ]
  }
}

Worth knowing

  • history is capped at the 50 most recent entries, newest first.

  • Targeting depends on the type: a page experiment lists pages, a price experiment lists products.

  • 404 covers anything the API will not show you: another store's experiment, a draft, a deleted one, or a type the API does not support.

Last updated