Partially Update Experiment

PATCH /console/v1/experiments/{id}

Partially Update Experiment

cURL

curl --request PATCH \
  --url https://statsigapi.net/console/v1/experiments/{id} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "description": "<string>",
  "idType": "<string>",
  "secondaryIDType": "<string>",
  "hypothesis": "<string>",
  "links": [
    {
      "url": "<string>",
      "title": "<string>"
    }
  ],
  "groups": [
    {
      "name": "<string>",
      "size": 50,
      "parameterValues": {},
      "id": "<string>",
      "disabled": true,
      "description": "<string>",
      "foreignGroupID": "<string>"
    }
  ],
  "controlGroupID": "<string>",
  "allocation": 50,
  "primaryMetricTags": [
    "<string>"
  ],
  "secondaryMetricTags": [
    "<string>"
  ],
  "primaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>",
      "hypothesizedValue": 123
    }
  ],
  "secondaryMetrics": [
    {
      "name": "<string>",
      "type": "<string>",
      "hypothesizedValue": 123
    }
  ],
  "targetApps": "<string>",
  "tags": [
    "<string>"
  ],
  "duration": 2,
  "targetExposures": 2,
  "targetingGateID": "<string>",
  "sequentialTesting": true,
  "bonferroniCorrection": true,
  "bonferroniCorrectionPerMetric": true,
  "benjaminiHochbergPerVariant": true,
  "benjaminiHochbergPerMetric": true,
  "benjaminiPrimaryMetricsOnly": true,
  "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,
  "analysisEndTime": "<string>",
  "precommitWebhook": {
    "url": "<string>",
    "internalStatusUrl": "<string>"
  },
  "assignmentSourceFilters": [
    {
      "column": "<string>",
      "values": [
        "<string>"
      ]
    }
  ]
}
'

200

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

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

id

Body

application/json

description · string

A helpful summary of what this experiment does

Maximum string length: 1000

idType · string

The type of ID which the experiment is based 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

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

targetApps · string string[]

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

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

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

precommitWebhook · object | null

Show child attributes

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

Response

200

application/json

Partially Update Experiment Success

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes