Partially Update Experiment Overrides

patchhttps://statsigapi.net/console/v1/experiments/{id}/overrides

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

Body

application/json

overridesobject[]required

Array of experiment overrides, each specifying type, ID, and group ID.

Show child attributes

type[]stringrequired

id[]stringrequired

The id of the segment or gate

groupID[]stringrequired

The experiment group which user will be forced into

environment[]string

Optional environment designation (e.g., production, staging) for the experiment.

userIDOverridesobject[]required

Array of user ID overrides, specifying which users to force into experiment groups.

Show child attributes

groupID[]stringrequired

The experiment group the user will be forced into.

ids[]string[]required

Array of user IDs to be assigned to the specified experiment group.

environment[]string

Optional environment designation (e.g., production, staging) for the experiment.

unitType[]string

Optional type of unit for the experiment, defining the scope of the override.

Response

application/json

200Partially Update Experiment Overrides Success

messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Show child attributes

overridesobject[]required

Array of experiment overrides, each specifying type, ID, and group ID.

Show child attributes

type[]stringrequired

id[]stringrequired

The id of the segment or gate

groupID[]stringrequired

The experiment group which user will be forced into

environment[]string

Optional environment designation (e.g., production, staging) for the experiment.

userIDOverridesobject[]required

Array of user ID overrides, specifying which users to force into experiment groups.

Show child attributes

groupID[]stringrequired

The experiment group the user will be forced into.

ids[]string[]required

Array of user IDs to be assigned to the specified experiment group.

environment[]string

Optional environment designation (e.g., production, staging) for the experiment.

unitType[]string

Optional type of unit for the experiment, defining the scope of the override.

401This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx

statusintegerrequired

messagestringrequired

404Experiment not found.

statusintegerrequired

messagestringrequired

Partially Update Experiment Overrides

curl -X PATCH "https://statsigapi.net/console/v1/experiments/{id}/overrides" \
  -H "Content-Type: application/json" \
  -H "STATSIG-API-KEY: YOUR_API_KEY"

Response

{
  "overrides": [
    {
      "type": "gate",
      "id": "a_gate",
      "groupID": "Test"
    }
  ],
  "userIDOverrides": [
    {
      "groupID": "Control",
      "ids": [
        "newly_added_id"
      ]
    }
  ]
}

Was this helpful?