Audit Overrides

Returns overrides across all gates, holdouts, experiments, and layers in the project. Provide userId (optionally with idType ) to audit everywhere a single u…

Returns overrides across all gates, holdouts, experiments, and layers in the project. Provide userId (optionally with idType) to audit everywhere a single unit ID is overridden; omit it to export every override. Each section only lists entities that have matching overrides.

gethttps://statsigapi.net/console/v1/overrides

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

userIdstring

Unit ID to audit. When provided, the response only includes entities that override this ID, narrowed to the matching ID. When omitted, every override across all entities is returned.

Example:user-123
idTypestring

The unit ID type that userId refers to (e.g. 'userID', 'stableID', or a custom unit ID type). Accepts snake_case or camelCase. Defaults to 'userID'. Ignored when userId is omitted.

Example:userID

Response

application/json
200· Audit Overrides Success
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired

Overrides grouped by entity type. Each section only lists entities that have (matching) overrides.

Show child attributes
gatesobject[]required

Feature gates with matching overrides.

idstringrequired

Entity identifier (name)

Example:my_gate
namestringrequired

Entity display name

Example:My Gate
passingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
failingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
passingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
failingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
environmentOverridesobject[]required
environmentstring

Environment

Example:staging
Constraints:nullable
unitIDstringrequired

Unit ID

Example:unit123
Constraints:nullable
passingIDsstring[]required

List of passing IDs

Example:["id1","id2"]
failingIDsstring[]required

List of failing IDs

Example:["id3","id4"]
holdoutsobject[]required

Holdouts with matching overrides.

idstringrequired

Entity identifier (name)

Example:my_gate
namestringrequired

Entity display name

Example:My Gate
passingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
failingUserIDsstring[]required

List of user IDs

Example:["user123","user456","user789"]
passingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
failingCustomIDsstring[]

Optional list of custom IDs

Example:["custom123","custom456"]
environmentOverridesobject[]required
environmentstring

Environment

Example:staging
Constraints:nullable
unitIDstringrequired

Unit ID

Example:unit123
Constraints:nullable
passingIDsstring[]required

List of passing IDs

Example:["id1","id2"]
failingIDsstring[]required

List of failing IDs

Example:["id3","id4"]
experimentsobject[]required

Experiments with matching overrides.

idstringrequired

Entity identifier (name)

Example:my_gate
namestringrequired

Entity display name

Example:My Gate
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
layersobject[]required

Layers with matching overrides.

idstringrequired

Entity identifier (name)

Example:my_gate
namestringrequired

Entity display name

Example:My Gate
conditionalOverridesobject[]required
typestringrequired

Describes whether layer override is segment or gate

namestringrequired

Name of override entity

experimentNamestringrequired
groupNamestringrequired
environmentstring

Optional environment scope (e.g. production, staging). Omit or pass null to target the all-environments bucket.

Constraints:nullable
idOverridesobject[]required
groupNamestringrequired

Group that ID is overriden into

idsstring[]required

ID being overriden into a particular group

idTypestring
Constraints:nullable
environmentstring
Constraints:nullable
experimentNamestring
Constraints:nullable
400· Invalid request. Please check the request input and try again.
statusintegerrequired
Allowed values:400
messagestringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
Allowed values:401
messagestringrequired

Was this helpful?