API referenceAdmin
List the platform experiments
Returns every experiment with its variants and current status. Platform admins only.
Authorization
apiKey AuthorizationBearer <token>
Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/admin/experiments"{ "data": [ { "id": "string", "name": "string", "hypothesis": "string", "targetType": "flag", "targetKey": "string", "assignmentUnit": "workspace", "status": "draft", "flagKey": "string", "audience": "string", "allocation": 0, "primaryMetric": "string", "guardrailMetric": "string", "startedAt": "string", "endsAt": "string", "winner": "string", "variants": [ { "id": "string", "label": "string", "split": 0, "exposures": 0, "conversionRate": 0, "errorRate": 0 } ] } ]}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Update a feature flag's rollout
Changes a registered flag's enablement, percentage, or segment targeting and records an audit event. Platform admins only; the payload must carry a rollout `reason`, and a `flagId` that is not registered is reported as not found.
Create a platform experiment
Registers an experiment with its variants and targeting, and returns the created record. Platform admins only; an invalid variant set or a duplicate key is rejected as a validation error.