Shipeasy
Flags experimentsApiOperations

Transition experiment status

Drives the experiment lifecycle. Allowed transitions:

Drives the experiment lifecycle. Allowed transitions:

  • draft → running — starts allocation. Bumps the startedAt timestamp.
  • running → stopped — halts allocation. Existing exposures stay in the dataset.
  • stopped → archived — soft-delete.
  • draft → archived — discard an unstarted experiment.
  • archived → draft — restore a soft-deleted experiment so it can be re-completed and started. Allowed only if it never started; one that already ran must be cloned instead.

Restarting an archived experiment directly is not allowed — restore it to draft first. Returns 409 on illegal transitions and 429 if the plan's experiments_running limit is exceeded on → running.

Use cases
  • Start — { "status": "running" } after wiring up the SDK and verifying targeting on staging.
  • Stop — { "status": "stopped" } once the experiment hits its min_runtime_days and conclusive results land.
  • Archive — { "status": "archived" } to soft-delete after sign-off.
POST
/api/admin/experiments/{id}/status

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

id*string

Stable opaque experiment id (exp_…) or the experiment's name.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://shipeasy.ai/api/admin/experiments/string/status" \  -H "Content-Type: application/json" \  -d '{    "status": "running"  }'
{
  "id": "exp_01j7wb12c3d4e5f6g7h8j9k0l1",
  "status": "running"
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page