Experiments

The account’s experiments, newest first#

GET /v1/account/experiments

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token). Bearer token: Authorization: Bearer <token> (An API token (ans_pat_ or ans_svc_). Only routes that list a scope here accept one, and only with that scope.).

Query parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/experiments" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Plan an experiment: two or three published versions of one playbook on a number assignment, a route of a number’s schedule or a widget key, a split, a target metric chosen in advance, a minimum sample and an end date#

POST /v1/account/experiments

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Request body

application/json, required.

Response 201

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/experiments" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "scopeKind": "number_assignment",
  "scopeId": "string",
  "playbookId": "pb_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
  "arms": [
    {
      "playbookVersionId": "pbv_2ZPh7XbT0v9Ao4iJ3qK1mN8sRgE",
      "weight": 10
    }
  ],
  "targetMetric": "target_attainment",
  "endsAt": "2026-01-15T15:30:00Z"
}'

One experiment and its results per arm: every catalogue metric with n and its interval, and verdicts against the control; the target metric’s is labelled tested once every arm has its sample#

GET /v1/account/experiments/{experimentId}

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token). Bearer token: Authorization: Bearer <token> (An API token (ans_pat_ or ans_svc_). Only routes that list a scope here accept one, and only with that scope.).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X GET "$ANSWERSTACK_API_URL/v1/account/experiments/{experimentId}" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Start splitting traffic. Every arm’s effective playbook for the group is computed first; the start is refused if one needs review#

POST /v1/account/experiments/{experimentId}/start

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/experiments/{experimentId}/start" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Stop an experiment now. Its traffic goes back to the usual version, and its results so far are kept#

POST /v1/account/experiments/{experimentId}/stop

Authentication: Bearer token: Authorization: Bearer <token> (Supabase access token).

Path parameters

Response 200

Errors: 400, 401, 403, 404, 409, 429, 500, with an ErrorBody body.

Example

curl -X POST "$ANSWERSTACK_API_URL/v1/account/experiments/{experimentId}/stop" \
  -H "Authorization: Bearer $ACCESS_TOKEN"