PATCH
/
console
/
v1
/
experiments
/
{id}
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>",
      "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
    }
  ],
  "targetApps": "<string>",
  "tags": [
    "<string>"
  ],
  "duration": 2,
  "targetExposures": 2,
  "targetingGateID": "<string>",
  "sequentialTesting": true,
  "bonferroniCorrection": true,
  "bonferroniCorrectionPerMetric": true,
  "benjaminiHochbergPerVariant": true,
  "benjaminiHochbergPerMetric": true,
  "benjaminiPrimaryMetricsOnly": true,
  "defaultConfidenceInterval": "80",
  "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>",
  "precommitWebhook": {
    "url": "<string>",
    "internalStatusUrl": "<string>"
  },
  "assignmentSourceFilters": [
    {
      "column": "<string>",
      "condition": "in",
      "values": [
        "<string>"
      ]
    }
  ],
  "analyticsType": "frequentist"
}'
{
  "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

Response

200
application/json

Partially Update Experiment Success

The response is of type object.