Skip to main content
POST
/
console
/
v1
/
experiments
/
{id}
Fully Update Experiment
curl --request POST \
  --url https://statsigapi.net/console/v1/experiments/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "idType": "<string>",
  "secondaryIDType": "<string>",
  "identifierMappingMode": "strictOneToOne",
  "identityResolutionSource": "<string>",
  "hypothesis": "<string>",
  "links": [
    {
      "url": "<string>",
      "title": "<string>"
    }
  ],
  "groups": [
    {
      "name": "<string>",
      "id": "<string>",
      "size": 50,
      "parameterValues": {},
      "disabled": true,
      "description": "<string>",
      "foreignGroupID": "<string>"
    }
  ],
  "controlGroupID": "<string>",
  "allocation": 50,
  "primaryMetricTags": [
    "<string>"
  ],
  "secondaryMetricTags": [
    "<string>"
  ],
  "primaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>",
      "direction": "increase",
      "hypothesizedValue": 123
    }
  ],
  "secondaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>",
      "direction": "increase",
      "hypothesizedValue": 123
    }
  ],
  "otherMetrics": [
    {
      "name": "<string>",
      "type": "<string>",
      "direction": "increase",
      "hypothesizedValue": 123
    }
  ],
  "targetApps": "<string>",
  "tags": [
    "<string>"
  ],
  "duration": 2,
  "targetExposures": 2,
  "targetingGateID": "<string>",
  "sequentialTesting": true,
  "bonferroniCorrection": true,
  "bonferroniCorrectionPerMetric": true,
  "benjaminiHochbergPerVariant": true,
  "benjaminiHochbergPerMetric": true,
  "benjaminiPrimaryMetricsOnly": true,
  "defaultConfidenceInterval": "80",
  "manualQualityScores": [
    {
      "criteriaName": "HYPOTHESIS_LENGTH",
      "status": "PASSED",
      "criteriaDescription": "<string>",
      "score": 123,
      "weight": 123
    }
  ],
  "status": "active",
  "launchedGroupID": "<string>",
  "assignmentSourceName": "<string>",
  "assignmentSourceExperimentName": "<string>",
  "creatorID": "<string>",
  "creatorEmail": "<string>",
  "isAnalysisOnly": true,
  "team": "<string>",
  "teamID": "<string>",
  "allocationDuration": 2,
  "cohortedAnalysisDuration": 2,
  "cohortedMetricsMatureAfterEnd": true,
  "cohortWaitUntilEndToInclude": true,
  "fixedAnalysisDuration": 2,
  "scheduledReloadHour": 11,
  "scheduledReloadType": "full",
  "analysisEndTime": "<string>",
  "assignmentSourceFilters": [
    {
      "column": "<string>",
      "condition": "in",
      "values": [
        "<string>"
      ]
    }
  ],
  "analyticsType": "frequentist",
  "isSidecar": true,
  "decisionReason": "<string>",
  "preComputedUserDimensions": [
    {
      "propertySource": "<string>",
      "name": "<string>"
    }
  ],
  "cureCovariates": [
    {
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "stratifiedSampling": {
    "status": "pending",
    "metric": {
      "name": "<string>",
      "startDate": "<string>",
      "endDate": "<string>"
    },
    "entityPropertySource": {
      "propertySourceName": "<string>",
      "column": "<string>"
    },
    "csv": {
      "original": "<string>",
      "identifier": "<string>"
    }
  }
}'
{
  "message": "string",
  "data": {
    "id": "a_experiment",
    "description": "a helpful summary of what this experiment does",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "f0JAV9dd7KF0sUbi1DHWB",
    "idType": "userID",
    "status": "setup",
    "layerID": "layer1",
    "hypothesis": "Does 1 or 0 work better?",
    "primaryMetrics": [
      {
        "name": "l14",
        "type": "user"
      }
    ],
    "primaryMetricTags": [],
    "secondaryMetrics": [
      {
        "name": "mau_28d",
        "type": "user"
      }
    ],
    "secondaryMetricTags": [],
    "groups": [
      {
        "name": "group1",
        "size": 50,
        "parameterValues": {
          "key": 1
        }
      },
      {
        "name": "gruop2",
        "size": 50,
        "parameterValues": {
          "key": 0
        }
      }
    ],
    "allocation": 50.46,
    "duration": 14,
    "targetingGateID": "a_gate",
    "defaultConfidenceInterval": "95",
    "bonferroniCorrection": false,
    "tags": []
  }
}

Authorizations

STATSIG-API-KEY
string
header
required

Headers

x-respect-review-settings
string

Path Parameters

id
string
required

Body

application/json
description
string
required
Maximum length: 1000
idType
string
required
hypothesis
string
required
groups
object[]
required
allocation
number
required
Required range: 0 <= x <= 100
targetingGateID
string | null
required
bonferroniCorrection
boolean
required
defaultConfidenceInterval
enum<string>
required
Available options:
80,
90,
95,
98,
99
status
enum<string>
required
Available options:
active,
setup,
decision_made,
abandoned,
archived,
experiment_stopped,
assignment_stopped
name
string
Required string length: 3 - 100
secondaryIDType
string | null
identifierMappingMode
enum<string>
Available options:
strictOneToOne,
firstTouchOneToMany,
lastTouchOneToMany
identityResolutionSource
string | null
controlGroupID
string
primaryMetricTags
string[]
secondaryMetricTags
string[]
primaryMetrics
object[]
secondaryMetrics
object[]
otherMetrics
object[]
targetApps
tags
string[]
duration
integer
Required range: x > 1
targetExposures
integer
Required range: x > 1
sequentialTesting
boolean
bonferroniCorrectionPerMetric
boolean
benjaminiHochbergPerVariant
boolean
benjaminiHochbergPerMetric
boolean
benjaminiPrimaryMetricsOnly
boolean
manualQualityScores
object[]
launchedGroupID
string | null
assignmentSourceName
string
assignmentSourceExperimentName
string
creatorID
string | null
creatorEmail
string | null
isAnalysisOnly
boolean | null
team
string | null
teamID
string | null
allocationDuration
integer | null
Required range: x > 1
cohortedAnalysisDuration
integer
Required range: x > 1
cohortedMetricsMatureAfterEnd
boolean
cohortWaitUntilEndToInclude
boolean
fixedAnalysisDuration
integer
Required range: x > 1
scheduledReloadHour
integer | null
Required range: 0 <= x <= 23
scheduledReloadType
enum<string>
Available options:
full,
incremental
analysisEndTime
string
assignmentSourceFilters
object[]
analyticsType
enum<string>
Available options:
frequentist,
bayesian,
sprt
isSidecar
boolean
decisionReason
string
preComputedUserDimensions
object[]
cureCovariates
object[]
stratifiedSampling
object | null

Response

message
string
required
data
object
required