Skip to main content
POST
Create holdout

Authorizations

Authorization
string
header
required

Path Parameters

projectKey
string<string>
required

The project key

environmentKey
string<string>
required

The environment key

Body

application/json
name
string

A human-friendly name for the holdout

Example:

"holdout-one-name"

key
string

A key that identifies the holdout

Example:

"holdout-key"

description
string

Description of the holdout

Example:

"My holdout-one description"

randomizationunit
string

The chosen randomization unit for the holdout base experiment

Example:

"user"

attributes
string[]

The attributes that the holdout iteration's results can be sliced by

Example:
holdoutamount
string

Audience allocation for the holdout

Example:

"10"

primarymetrickey
string

The key of the primary metric for this holdout

Example:

"metric-key-123abc"

metrics
object[]

Details on the metrics for this experiment

prerequisiteflagkey
string

The key of the flag that the holdout is dependent on

Example:

"flag-key-123abc"

maintainerId
string

Maintainer id

Response

Holdout response

_id
string
required
status
enum<string>
required
Available options:
created,
enabled,
running,
ended
holdoutAmount
string
required

The percentage of traffic allocated to this holdout.

createdAt
integer<int64>
required
updatedAt
integer<int64>
required
baseExperiment
object
required
description
string
experiments
object[]