Get holdout by id

gethttps://statsigapi.net/console/v1/holdouts/{id}

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Path parameters

idstringrequired

id

Response

application/json
200· Get holdout by id response
messagestringrequired

A simple string explaining the result of the operation.

dataobjectrequired
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

lastModifierIDstringrequired

ID of the last modifier.

lastModifiedTimenumberrequired

Time of the last modification.

lastModifierEmailstringrequired

Email of the last modifier.

lastModifierNamestringrequired

Name of the last modifier.

creatorIDstringrequired

ID of the user who created the entity.

createdTimenumberrequired

Timestamp when the entity was created.

creatorNamestringrequired

Name of the creator.

creatorEmailstringrequired

Email of the creator.

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.

teamIDstring

Optional ID of the responsible team.

versionnumber

Version number

permalinkstringrequired

A permalink to this holdout in the Statsig Console.

isEnabledbooleanrequired

enable or disable the holdout

passPercentagenumberrequired

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

gateIDsstring[]required

an array of gateIDs which this holdout is applied to

experimentIDsstring[]required

an array of experimentIDs which this holdout is applied to

layerIDsstring[]required

an array of layerIDs which this holdout is applied to

isGlobalbooleanrequired

whether the holdout is being applied to all new gates

targetingGateIDstringrequired

the gateID that the holdout is targeting

monitoringMetricsobject[]
name[]stringrequired
type[]stringrequired
401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
messagestringrequired

Was this helpful?