POST
/
console
/
v1
/
experiments
/
{id}
/
disable_groups
Disable Experiment Groups
curl --request POST \
  --url https://statsigapi.net/console/v1/experiments/{id}/disable_groups \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '{
  "group_names": [
    "<string>"
  ]
}'
{
  "message": "<string>",
  "data": {
    "reviewSettings": {
      "requiredReview": true,
      "allowedReviewers": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "<string>"
        }
      ]
    },
    "activeReview": {
      "reviewID": "<string>",
      "reviewStatus": "<string>",
      "description": "<string>"
    },
    "id": "<string>",
    "name": "<string>",
    "idType": "<string>",
    "description": "<string>",
    "lastModifierID": "<string>",
    "lastModifiedTime": 123,
    "lastModifierEmail": "<string>",
    "lastModifierName": "<string>",
    "creatorID": "<string>",
    "createdTime": 123,
    "creatorName": "<string>",
    "creatorEmail": "<string>",
    "tags": [
      "<string>"
    ],
    "targetApps": "<string>",
    "holdoutIDs": [
      "<string>"
    ],
    "team": "<string>",
    "teamID": "<string>",
    "version": 123,
    "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
      }
    ],
    "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>",
    "isAnalysisOnly": true,
    "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": "<string>",
    "subtype": "conversion",
    "externalExperimentName": "<string>",
    "layerID": "<string>",
    "startTime": 123,
    "endTime": 123,
    "decisionReason": "<string>",
    "decisionTime": 123,
    "healthChecks": [
      {
        "name": "<string>",
        "description": "<string>",
        "status": "PASSED",
        "metadata": {
          "type": "<string>",
          "lastPulseLoadTime": 123,
          "crossoverPercent": 123,
          "assignmentSourceID": "<string>",
          "assignmentSourceName": "<string>",
          "foreignExperimentID": "<string>",
          "deduplication_rate": 123,
          "deduplication_rates": [
            {
              "group_id": "<string>",
              "rate": 123,
              "group_name": "<string>"
            }
          ],
          "primary_id_type": "<string>",
          "secondary_id_type": "<string>",
          "missingMetrics": [
            "<string>"
          ],
          "metrics": [
            {
              "metric_name": "<string>",
              "earliest_date": "2023-11-07T05:31:56Z",
              "latest_date": "2023-11-07T05:31:56Z"
            }
          ],
          "lastUpdatedDs": "<string>"
        },
        "type": "has_checks"
      }
    ],
    "healthCheckStatus": "PASSED",
    "owner": {
      "ownerID": "user123",
      "ownerType": "USER",
      "ownerName": "John Doe",
      "ownerEmail": "owner123@test.com"
    },
    "inlineTargetingRulesJSON": "<string>"
  }
}

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

201
application/json

Disable experiment groups

The response is of type object.