List Holdouts

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

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

creatorNamestring

Name of the creator.

Constraints:nullable
creatorIDstring

ID of the user who created the entity.

Constraints:nullable
tagsoneOf

Filter by tags

Constraints:stringstring[]
limitinteger

Results per page

Example:10
Constraints:stringnumber
pageinteger

Page number

Example:1
Constraints:stringnumber

Response

application/json
200· List holdouts response
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
idstringrequired

ID

namestring

Optional name for the configuration.

idTypestringrequired

type of id

descriptionstringrequired

brief summary of what the holdout is being used for

Example:example holdout description
Constraints:max length: 1000
lastModifierIDstringrequired

ID of the last modifier.

Constraints:nullable
lastModifiedTimenumberrequired

Time of the last modification.

Constraints:format: doublenullable
lastModifierEmailstringrequired

Email of the last modifier.

Constraints:nullable
lastModifierNamestringrequired

Name of the last modifier.

Constraints:nullable
creatorIDstringrequired

ID of the user who created the entity.

Constraints:nullable
createdTimenumberrequired

Timestamp when the entity was created.

Constraints:format: double
creatorNamestringrequired

Name of the creator.

Constraints:nullable
creatorEmailstringrequired

Email of the creator.

Constraints:nullable
tagsstring[]

Optional tags for categorization.

targetAppsstring[]

List of target applications associated with this configuration.

holdoutIDsstring[]

Holdouts applied to this configuration.

teamstring

Optional name for the responsible team.

Constraints:nullable
teamIDstring

Optional ID of the responsible team.

Constraints:nullable
versionnumber

Version number

Constraints:format: double
permalinkstringrequired

A permalink to this holdout in the Statsig Console.

Constraints:format: uri
isEnabledbooleanrequired

enable or disable the holdout

Example:true
passPercentagenumberrequired

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

Example:5
Constraints:format: doublemin: 0max: 10
gateIDsstring[]required

an array of gateIDs which this holdout is applied to

Example:["4pjeXYDjC2WinSgOiII7wh"]
experimentIDsstring[]required

an array of experimentIDs which this holdout is applied to

Example:["70fCNphHGesdLwHdHau99q"]
layerIDsstring[]required

an array of layerIDs which this holdout is applied to

Example:["5O908pyGoCqw6QH1nt8v82"]
isGlobalbooleanrequired

whether the holdout is being applied to all new gates

Example:false
targetingGateIDstringrequired

the gateID that the holdout is targeting

Example:4pjeXYDjC2WinSgOiII7wh
Constraints:nullable
monitoringMetricsobject[]
namestringrequired
typestringrequired
paginationobjectrequired

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

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?