SnozeDevelopers
API referenceAdmin

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.

POST
/v1/admin/experiments

Authorization

apiKey
headerAuthorizationBearer <snoze_sk_…>

Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.

Request Body

application/json
  1. body
name*string
hypothesis?string|null
flagId?string|null
targetType?|null
targetKey?string|null
assignmentUnit?|null
audience?string|null
allocation?number|null
primaryMetric?string|null
guardrailMetric?string|null
variants?array<string>|null

Response Body

Success

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.snoze.dev/v1/admin/experiments' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "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      }    ]  }}