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": "[email protected]",
"creatorID": "5O908pyGoCqw6QH1nt8v82",
"createdTime": 1719872027567,
"creatorName": "Test User",
"creatorEmail": "[email protected]",
"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": "[email protected]",
"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"
}
}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": "[email protected]",
"creatorID": "5O908pyGoCqw6QH1nt8v82",
"createdTime": 1719872027567,
"creatorName": "Test User",
"creatorEmail": "[email protected]",
"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": "[email protected]",
"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"
}
}Optional header to respect review settings for mutation endpoints.
Name of the creator.
ID of the user who created the entity.
Filter by tags
Results per page
10
Page number
1
List holdouts response
A simple string explaining the result of the operation.
Array of results returned by pagination limit.
Show child attributes
ID
type of id
brief summary of what the holdout is being used for
1000"example holdout description"
ID of the last modifier.
Time of the last modification.
Email of the last modifier.
Name of the last modifier.
ID of the user who created the entity.
Timestamp when the entity was created.
Name of the creator.
Email of the creator.
enable or disable the holdout
true
percentage of users between 0-10% to pass through the holdout
0 <= x <= 105
an array of gateIDs which this holdout is applied to
["4pjeXYDjC2WinSgOiII7wh"]an array of experimentIDs which this holdout is applied to
["70fCNphHGesdLwHdHau99q"]an array of layerIDs which this holdout is applied to
["5O908pyGoCqw6QH1nt8v82"]whether the holdout is being applied to all new gates
false
the gateID that the holdout is targeting
"4pjeXYDjC2WinSgOiII7wh"
Optional name for the configuration.
Optional tags for categorization.
List of target applications associated with this configuration.
Holdouts applied to this configuration.
Optional name for the responsible team.
Optional ID of the responsible team.
Version number
Pagination metadata for checking if there is next page for example.
Was this page helpful?