Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Overrides

Audit Overrides

Returns overrides across all gates, holdouts, experiments, autotunes, 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.

get/console/v1/overrides

Query parameters

userIdstring
Example:user-123

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.

idTypestring
Example:userID

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.

Response

Audit Overrides Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Overrides read successfully.",
  "data": {
    "gates": [
      {
        "id": "my_gate",
        "name": "My Gate",
        "passingUserIDs": [
          "user-123"
        ],
        "failingUserIDs": [],
        "environmentOverrides": [
          {
            "environment": null,
            "unitID": "userID",
            "passingIDs": [
              "user-123"
            ],
            "failingIDs": []
          }
        ]
      }
    ],
    "holdouts": [],
    "experiments": [
      {
        "id": "my_experiment",
        "name": "My Experiment",
        "overrides": [],
        "userIDOverrides": [
          {
            "groupID": "Control",
            "ids": [
              "user-123"
            ],
            "environment": null,
            "unitType": "userID"
          }
        ]
      }
    ],
    "autotunes": [],
    "layers": []
  }
}