For AI agents: a documentation index is available at /llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.

Get Experiment Overrides

Get Experiment Overrides

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

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Response

application/json
200· Get 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.

typestringrequired
Allowed values:gatesegment
idstringrequired

The id of the segment or gate

groupIDstringrequired

The experiment group which user will be forced into

environmentstring

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

Constraints:nullable
userIDOverridesobject[]required

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

groupIDstringrequired

The experiment group the user will be forced into.

idsstring[]required

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

environmentstring

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

Constraints:nullable
unitTypestring

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

Constraints:nullable
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired
404· Experiment not found.
statusintegerrequired
Allowed values:404
messagestringrequired

Was this helpful?