Create Experiment

POST

console

experiments

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

name

string

required

The name of the new experiment

Required string length: 3 - 100

description

string

A description of the new experiment

Maximum length: 1000

idType

string

The idType the experiment will be performed on

secondaryIDType

string | null

The secondary ID type for the experiment used in WHN for ID resolution

hypothesis

string

A statement that will be tested by this experiment

links

object[]

Links to relevant documentation or resources

groups

object[]

The test groups for your experiment

controlGroupID

string

Optional control group ID

allocation

number

Percent of layer allocated to this experiment

Required range: 0 <= x <= 100

primaryMetricTags

string[]

Primary metric tags for the experiment

secondaryMetricTags

string[]

Secondary metric tags for the experiment

primaryMetrics

object[]

Main metrics needed to evaluate your hypothesis

secondaryMetrics

object[]

Additional metrics to monitor that might impact the analysis or final decision of the experiment

targetApps

Target apps assigned to this experiment

Response

201

application/json

Create Experiment Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

data.id

string

required

data.idType

string

required

data.description

string

required

A helpful summary of what this experiment does

Maximum length: 1000

data.lastModifierID

string | null

required

ID of the last modifier.

data.lastModifiedTime

number | null

required

Time of the last modification.

data.lastModifierEmail

string | null

required

Email of the last modifier.

data.lastModifierName

string | null

required

Name of the last modifier.

data.createdTime

number

required

Timestamp when the entity was created.

data.creatorName

string | null

required

Name of the creator.

data.tags

string[]

required

data.hypothesis

string

required

A statement that will be tested by this experiment

data.groups

object[]

required

The test groups for your experiment

data.allocation

number

required

Percent of layer allocated to this experiment

Required range: 0 <= x <= 100

data.primaryMetrics

object[]

required

data.secondaryMetrics

object[]

required

data.targetingGateID

string | null

required

Restrict your experiment to users passing the selected feature gate

data.bonferroniCorrection

boolean

required

Is Bonferroni correction applied per variant?

data.defaultConfidenceInterval

enum<string>

required

Default error margin used for results

Available options:

80,

90,

95,

98,

99

data.status

enum<string>

required

The current status of the experiment

Available options:

active,

setup,

decision_made,

abandoned,

archived,

experiment_stopped,

assignment_stopped

data.layerID

string | null

required

data.startTime

number | null

required

data.endTime

number | null

required

data.decisionReason

string | null

required

data.decisionTime

number | null

required

data.healthCheckStatus

enum<string>

required

Overall health check status

Available options:

PASSED,

FAILED,

WAITING,

WARNING

data.reviewSettings

object

data.activeReview

object

data.name

string

Optional name for the configuration.

data.creatorID

string | null

The Statsig ID of the creator of this experiment

data.creatorEmail

string | null

The email of the creator of this experiment

data.targetApps

Target apps assigned to this experiment

data.holdoutIDs

string[]

Holdouts applied to this configuration.

data.team

string | null

The team name associated with the experiment, Enterprise only.

data.teamID

string | null

The team ID associated with the experiment, Enterprise only.

data.version

number

Version number

data.secondaryIDType

string | null

The secondary ID type for the experiment used in WHN for ID resolution

data.links

object[]

Links to relevant documentation or resources

data.controlGroupID

string

Optional control group ID

data.primaryMetricTags

string[]

Primary metric tags for the experiment

data.secondaryMetricTags

string[]

Secondary metric tags for the experiment

data.duration

integer

How long the experiment is expected to last in days

Required range: x > 1

data.targetExposures

integer

Target exposures for the experiment

Required range: x > 1

data.sequentialTesting

boolean

Apply sequential testing?

data.bonferroniCorrectionPerMetric

boolean

Is Bonferroni correction applied per metric?

data.benjaminiHochbergPerVariant

boolean

Is Benjamini-Hochberg procedure applied per variant?

data.benjaminiHochbergPerMetric

boolean

Is Benjamini-Hochberg procedure applied per metric?

data.benjaminiPrimaryMetricsOnly

boolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

data.launchedGroupID

string | null

ID of the launched group, null otherwise

data.assignmentSourceName

string

data.assignmentSourceExperimentName

string

Name of the source experiment for assignment

data.isAnalysisOnly

boolean

data.allocationDuration

integer | null

Warehouse Native Only - Allocation duration in days

Required range: x > 1

data.cohortedAnalysisDuration

integer

Warehouse Native Only - Cohorted analysis duration in days

Required range: x > 1

data.cohortedMetricsMatureAfterEnd

boolean

Warehouse Native Only - Allow cohort metrics to mature after experiment end

data.cohortWaitUntilEndToInclude

boolean

Warehouse Native Only - Whether to filter to units whose experiment cohort analysis duration is complete, if cohortedAnalysisDuration exists

data.fixedAnalysisDuration

integer

Fixed analysis duration in days

Required range: x > 1

data.scheduledReloadHour

integer

Warehouse Native only - UTC hour at which to run scheduled pulse loads

Required range: 0 <= x <= 23

data.scheduledReloadType

enum<string>

Warehouse Native only - reload type for scheduled reloads

Available options:

full,

incremental

data.analysisEndTime

string

data.precommitWebhook

object | null

data.assignmentSourceFilters

object[]

Array of criteria for filtering assignment sources.

data.analyticsType

string | null

data.subtype

enum<string>

Available options:

conversion,

reactivation,

retention

data.externalExperimentName

string

data.healthChecks

object[]

data.owner

object | null

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "owner123@test.com"
}

data.inlineTargetingRulesJSON

string | null

List Experiments

Get 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": "{}"
  }
}

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

Create Experiment

Authorizations

Headers

Body

Response