Create holdout

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Body

application/json

name

string

required

name of the holdout

Required string length: 3 - 100

Example:

"team holdout"

description

string

description of the holdout

Maximum length: 1000

Example:

"holdout for this team"

idType

string

type of id

Example:

"userID"

teamID

string | null

id of the team

Example:

"4pjeXYDjC2WinSgOiII7wh"

Response

200

application/json

Create holdout response

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

data.id

string

required

ID

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