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

POST

console

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

name

string

required

The experiment display name

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

identifierMappingMode

enum<string>

The identifier mapping mode for the experiment used in WHN for ID resolution

Available options:

strictOneToOne,

firstTouchOneToMany,

lastTouchOneToMany

identityResolutionSource

string | null

The identity resolution entity property source 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

Show child attributes

groups

object[]

The test groups for your experiment

Show child attributes

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

Show child attributes

secondaryMetrics

object[]

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

Show child attributes

otherMetrics

object[]

Additional metrics you want to investigate or learn from. The usual corrections applied to Primary and Secondary metrics are not applied to these.

Show child attributes

targetApps

Target apps assigned to this experiment

tags

string[]

Tags associated with the experiment

duration

integer

How long the experiment is expected to last in days

Required range: x > 1

targetExposures

integer

Target exposures for the experiment

Required range: x > 1

targetingGateID

string | null

Restrict your experiment to users passing the selected feature gate

sequentialTesting

boolean

Apply sequential testing?

bonferroniCorrection

boolean

Is Bonferroni correction applied per variant?

bonferroniCorrectionPerMetric

boolean

Is Bonferroni correction applied per metric?

benjaminiHochbergPerVariant

boolean

Is Benjamini-Hochberg procedure applied per variant?

benjaminiHochbergPerMetric

boolean

Is Benjamini-Hochberg procedure applied per metric?

benjaminiPrimaryMetricsOnly

boolean

Is Benjamini-Hochberg procedure applied for primary metrics only?

defaultConfidenceInterval

enum<string>

Default error margin used for results

Available options:

80,

90,

95,

98,

99

manualQualityScores

object[]

Up to 10 manually set quality scores for an experiment. The scores and weights will be added to the existing weights and scores, and then weights will be renormalized to 100. This can be set via the Statsig Console API. If targeting a default check, the weight of the check will be updated, but not the status or description. A default score can be removed by setting the weight to 0. The default score identifiers are one of: HYPOTHESIS_LENGTH, BALANCED_EXPOSURE, PRIMARY_METRICS_LENGTH, COMPARISON_CORRECTION, GUARDRAIL_METRIC_TAGS, SUFFICIENT_SAMPLE, POWER_ANALYSIS, SEQUENTIAL_TESTING

Show child attributes

status

enum<string>

The current status of the experiment

Available options:

active,

setup,

decision_made,

abandoned,

archived,

experiment_stopped,

assignment_stopped

launchedGroupID

string | null

ID of the launched group, null otherwise

assignmentSourceName

string

Source name of the assignment

assignmentSourceExperimentName

string

Name of the source experiment for assignment

creatorID

string | null

The Statsig ID of the creator of this experiment

creatorEmail

string | null

The email of the creator of this experiment

isAnalysisOnly

boolean | null

For Warehouse Native

team

string | null

The team name associated with the experiment, Enterprise only.

teamID

string | null

The team ID associated with the experiment, Enterprise only.

allocationDuration

integer | null

Warehouse Native Only - Allocation duration in days

Required range: x > 1

cohortedAnalysisDuration

integer

Warehouse Native Only - Cohorted analysis duration in days

Required range: x > 1

cohortedMetricsMatureAfterEnd

boolean

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

cohortWaitUntilEndToInclude

boolean

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

fixedAnalysisDuration

integer

Fixed analysis duration in days

Required range: x > 1

scheduledReloadHour

integer | null

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

Required range: 0 <= x <= 23

scheduledReloadType

enum<string>

Warehouse Native only - reload type for scheduled reloads

Available options:

full,

incremental

analysisEndTime

string

Warehouse Native only - end time for analysis only experiments

assignmentSourceFilters

object[]

Array of criteria for filtering assignment sources.

Show child attributes

analyticsType

enum<string>

The mode of analysis for the experiment, e.g frequentist, bayesian, sprt

Available options:

frequentist,

bayesian,

sprt

isSidecar

boolean

Whether this is a Statsig Sidecar experiment.

decisionReason

string

Experiment notes reported after experiment completes

stratifiedSampling

object | null

The stratified sampling settings for the experiment

Show child attributes

string

The experiment name ID

Required string length: 3 - 100

layerID

string

Which layer to place the experiment into.

Response

Create Experiment Success

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

⌘I

List Experiments

Get Experiment

SDK Quickstarts

SDK Concepts

Client SDKs

Server SDKs

More SDK Methods

Console API Reference

Statsig CLI

HTTP API Reference

Create Experiment

Authorizations

Headers

Body

Response