List Holdouts

GET

console

holdouts

curl --request GET \
  --url https://statsigapi.net/console/v1/holdouts \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "message": "Holdouts listed successfully.",
  "data": [
    {
      "id": "testing_holdout",
      "name": "testing holdout",
      "description": "helpful summary of what this holdout does",
      "idType": "userID",
      "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
      "lastModifiedTime": 1719873874212,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
      "createdTime": 1719873870785,
      "creatorName": "CONSOLE API",
      "creatorEmail": null,
      "targetApps": [],
      "tags": [],
      "team": "Console Team",
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 0,
      "gateIDs": [],
      "experimentIDs": [],
      "layerIDs": [],
      "targetingGateID": null
    },
    {
      "id": "test123",
      "name": "test123",
      "description": "",
      "idType": "userID",
      "lastModifierID": "5O908pyGoCqw6QH1nt8v82",
      "lastModifiedTime": 1719872028057,
      "lastModifierName": "test",
      "lastModifierEmail": "user@statsig.com",
      "creatorID": "5O908pyGoCqw6QH1nt8v82",
      "createdTime": 1719872027567,
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "targetApps": [],
      "tags": [],
      "team": "Console Team",
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 0,
      "gateIDs": [],
      "experimentIDs": [],
      "layerIDs": [],
      "targetingGateID": null
    },
    {
      "id": "test_target_gate",
      "name": "test_target_gate",
      "description": "test holdout",
      "idType": "userID",
      "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
      "lastModifiedTime": 1710521134863,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "5sgBiiuoBX4fscrWdCXVma",
      "createdTime": 1702237002465,
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "targetApps": [],
      "tags": [],
      "team": null,
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 1,
      "gateIDs": [
        "product_larger_image",
        "product_larger_image_lower",
        "test_new_gate",
        "ma_test_rollout",
        "empty_gate",
        "new_gate_to_point_experiment_at",
        "new_gate_with_monitoring_metrics",
        "andy_test_gate"
      ],
      "experimentIDs": [
        "mostly_test_experiment",
        "test_123",
        "new_test_exp",
        "test_exp_start",
        "andy_test_experiment"
      ],
      "layerIDs": [
        "Homepage Feed Improvements",
        "statsig_is_awesome",
        "testing_tool",
        "test_statsig_2",
        "layer_holdout_parameters"
      ],
      "targetingGateID": ""
    }
  ],
  "pagination": {
    "itemsPerPage": 20000,
    "pageNumber": 1,
    "totalItems": 3,
    "nextPage": null,
    "previousPage": null,
    "all": "/console/v1/holdouts"
  }
}

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Query Parameters

creatorName

string | null

Name of the creator.

creatorID

string | null

ID of the user who created the entity.

Response

200

application/json

List holdouts response

message

string

required

A simple string explaining the result of the operation.

data

object[]

required

Array of results returned by pagination limit.

data.id

string

required

data.idType

string

required

type of id

data.description

string

required

brief summary of what the holdout is being used for

Maximum length: 1000

Example:

"example holdout description"

data.lastModifierID

string | null

required

ID of the last modifier.

data.lastModifiedTime

number | null

required

Time of the last modification.

data.lastModifierEmail

string | null

required

Email of the last modifier.

data.lastModifierName

string | null

required

Name of the last modifier.

data.creatorID

string | null

required

ID of the user who created the entity.

data.createdTime

number

required

Timestamp when the entity was created.

data.creatorName

string | null

required

Name of the creator.

data.creatorEmail

string | null

required

Email of the creator.

data.isEnabled

boolean

required

enable or disable the holdout

Example:

true

data.passPercentage

number

required

percentage of users between 0-10% to pass through the holdout

Required range: 0 <= x <= 10

Example:

5

data.gateIDs

string[]

required

an array of gateIDs which this holdout is applied to

Example:

["4pjeXYDjC2WinSgOiII7wh"]

data.experimentIDs

string[]

required

an array of experimentIDs which this holdout is applied to

Example:

["70fCNphHGesdLwHdHau99q"]

data.layerIDs

string[]

required

an array of layerIDs which this holdout is applied to

Example:

["5O908pyGoCqw6QH1nt8v82"]

data.isGlobal

boolean

required

whether the holdout is being applied to all new gates

Example:

false

data.targetingGateID

string | null

required

the gateID that the holdout is targeting

Example:

"4pjeXYDjC2WinSgOiII7wh"

data.name

string

Optional name for the configuration.

data.tags

string[]

Optional tags for categorization.

data.targetApps

string[]

List of target applications associated with this configuration.

data.holdoutIDs

string[]

Holdouts applied to this configuration.

data.team

string | null

Optional name for the responsible team.

data.teamID

string | null

Optional ID of the responsible team.

data.version

number

Version number

pagination

object

required

Pagination metadata for checking if there is next page for example.

List Gate Versions

Create holdout

curl --request GET \
  --url https://statsigapi.net/console/v1/holdouts \
  --header 'STATSIG-API-KEY: <api-key>'

{
  "message": "Holdouts listed successfully.",
  "data": [
    {
      "id": "testing_holdout",
      "name": "testing holdout",
      "description": "helpful summary of what this holdout does",
      "idType": "userID",
      "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
      "lastModifiedTime": 1719873874212,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
      "createdTime": 1719873870785,
      "creatorName": "CONSOLE API",
      "creatorEmail": null,
      "targetApps": [],
      "tags": [],
      "team": "Console Team",
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 0,
      "gateIDs": [],
      "experimentIDs": [],
      "layerIDs": [],
      "targetingGateID": null
    },
    {
      "id": "test123",
      "name": "test123",
      "description": "",
      "idType": "userID",
      "lastModifierID": "5O908pyGoCqw6QH1nt8v82",
      "lastModifiedTime": 1719872028057,
      "lastModifierName": "test",
      "lastModifierEmail": "user@statsig.com",
      "creatorID": "5O908pyGoCqw6QH1nt8v82",
      "createdTime": 1719872027567,
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "targetApps": [],
      "tags": [],
      "team": "Console Team",
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 0,
      "gateIDs": [],
      "experimentIDs": [],
      "layerIDs": [],
      "targetingGateID": null
    },
    {
      "id": "test_target_gate",
      "name": "test_target_gate",
      "description": "test holdout",
      "idType": "userID",
      "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
      "lastModifiedTime": 1710521134863,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "5sgBiiuoBX4fscrWdCXVma",
      "createdTime": 1702237002465,
      "creatorName": "Test User",
      "creatorEmail": "test@statsig.com",
      "targetApps": [],
      "tags": [],
      "team": null,
      "isEnabled": true,
      "isGlobal": false,
      "passPercentage": 1,
      "gateIDs": [
        "product_larger_image",
        "product_larger_image_lower",
        "test_new_gate",
        "ma_test_rollout",
        "empty_gate",
        "new_gate_to_point_experiment_at",
        "new_gate_with_monitoring_metrics",
        "andy_test_gate"
      ],
      "experimentIDs": [
        "mostly_test_experiment",
        "test_123",
        "new_test_exp",
        "test_exp_start",
        "andy_test_experiment"
      ],
      "layerIDs": [
        "Homepage Feed Improvements",
        "statsig_is_awesome",
        "testing_tool",
        "test_statsig_2",
        "layer_holdout_parameters"
      ],
      "targetingGateID": ""
    }
  ],
  "pagination": {
    "itemsPerPage": 20000,
    "pageNumber": 1,
    "totalItems": 3,
    "nextPage": null,
    "previousPage": null,
    "all": "/console/v1/holdouts"
  }
}

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

Authorizations

Headers

Query Parameters

Response