API referenceAdmin
Update a platform experiment
Changes an experiment's status, variants, or targeting. Platform admins only; an unknown `experimentId` is reported as not found.
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
Path Parameters
experimentId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/admin/experiments/string" \ -H "Content-Type: application/json" \ -d '{}'{ "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}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.
List the audience segments
Returns the segments available for feature flag and experiment targeting. Platform admins only.