Experiments

List experiments

Returns the project's experiments, newest first, with their variants and traffic split. Results and per-user assignments are not included. Experiments being deleted are not listed.

Scope: experiments:read

Request

GET /experiments?projectId=<project-id>

Parameters

Query	Required	Purpose
projectId	With an API key	The project to list.

Example

curl "https://sdk-api.funnelsgrove.com/integration/v1/experiments?projectId=<project-id>" \
  -H "Authorization: Bearer <api-key>"

Response

{
  "items": [{
    "id": "<experiment-id>",
    "type": "funnel",
    "key": "paywall-price",
    "name": "Paywall price",
    "funnelId": "<funnel-id>",
    "status": "running",
    "createdAt": "…",
    "updatedAt": "…",
    "startedAt": "…",
    "pausedAt": null,
    "endedAt": null,
    "variants": [
      { "key": "control", "label": "Control", "isControl": true, "trafficPercent": 50 },
      { "key": "cheap", "label": "Cheap", "isControl": false, "trafficPercent": 50 }
    ]
  }]
}

type	Meaning	Extra fields
funnel	Splits traffic inside one funnel. key is the experiment flag key.	funnelId
cross_funnel	Splits a domain path between funnels. key is null.	domain, pathPrefix; each variant has funnelId

status is draft, starting, running, pausing, paused or ended for funnel experiments, and draft, running, paused or ended for cross-funnel experiments.

Errors

Only the common errors.