Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

If using Bearer auth, pass the Secret Key as the token:

Body

application/json
name
string
required
Minimum string length: 1
description
string
Maximum string length: 10000
projects
string[]

Project IDs this Holdout applies to. Omit or send an empty array for All Projects.

owner
string

The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization.

tags
string[]
skipAsDefaultHoldout
boolean

When true, this Holdout is not selected automatically when creating Feature Flags or Experiments in Projects assigned to the Holdout.

holdoutSize
number

Proportion of traffic held out, expressed as a decimal (e.g. 0.05 for 5%). An equally-sized control group is bucketed alongside it. Defaults to 0.05. Maximum 0.5.

Required range: x <= 0.5
hashAttribute
string
targetingCondition
string

Targeting condition as a JSON string.

savedGroupTargeting
object[]
datasourceId
string
assignmentQueryId
string
goalMetrics
string[]
secondaryMetrics
string[]
statsEngine
enum<string>

Statistics engine used to analyze this Holdout.

Available options:
bayesian,
frequentist
environments
object

Per-environment state, keyed by environment ID. Environments not listed are disabled.

statusUpdateSchedule
object

Automatic stage transitions for the Holdout. Dates must be consecutive: startAt before startAnalysisPeriodAt before stopAt. Send null to delete the schedule.

Response

200 - application/json

Resource created

holdout
object
required