POST
/
console
/
v1
/
experiments
Create Experiment
curl --request POST \
  --url https://statsigapi.net/console/v1/experiments \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '{
  "name": "Test Experiment",
  "description": "Description test"
}'
{
  "message": "Experiment created successfully.",
  "data": {
    "id": "a_experiment",
    "name": "a_experiment",
    "description": "description",
    "idType": "userID",
    "lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
    "lastModifiedTime": 1707427635442,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "1vaQaBoLlkauH9iiuOSBP2",
    "createdTime": 1707427634717,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "holdoutIDs": [],
    "tags": [],
    "status": "setup",
    "launchedGroupID": null,
    "startTime": null,
    "endTime": null,
    "layerID": null,
    "hypothesis": "This will be a good feature :)",
    "primaryMetrics": [
      {
        "name": "d1_retention_rate",
        "type": "user"
      }
    ],
    "primaryMetricTags": [],
    "secondaryMetrics": [],
    "secondaryMetricTags": [],
    "groups": [
      {
        "name": "Control",
        "id": "6sEQvUd4c6E55V6ljBYMeJ",
        "size": 50,
        "parameterValues": {
          "assigned_group": "control"
        },
        "description": ""
      },
      {
        "name": "Test",
        "id": "6sEQvVS6EoNzpkEgUJUpxL",
        "size": 50,
        "parameterValues": {
          "assigned_group": "test"
        },
        "description": ""
      }
    ],
    "allocation": 100,
    "duration": 14,
    "targetingGateID": "",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "decisionReason": null,
    "decisionTime": null,
    "healthChecks": [],
    "healthCheckStatus": "PASSED",
    "inlineTargetingRulesJSON": "{}"
  }
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Body

application/json

Create Experiment

Response

201
application/json

Create Experiment Success

The response is of type object.