Holdout

string

required

dateCreated

string<date-time>

required

dateUpdated

string<date-time>

required

name

string

required

description

string

required

Maximum string length: 10000

projects

string[]

required

Project IDs this Holdout applies to. An empty array means All Projects.

owner

string

required

The userId of the owner (or raw owner name/email for legacy records)

tags

string[]

required

archived

boolean

required

stage

enum<string>

required

Lifecycle stage of the Holdout. Use the start, start-analysis, and stop endpoints to move through the lifecycle.

Available options:

draft,

running,

analysis-period,

stopped

trackingKey

string

required

experimentId

string

required

ID of the companion experiment that stores this Holdout's analysis. Use it with the experiment results endpoints (e.g. GET /experiments/{experimentId}/results). Pass phase=0 for results across the whole Holdout period, or phase=1 for results limited to the analysis period.

skipAsDefaultHoldout

boolean

required

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

holdoutSize

number

required

Proportion of traffic placed in the holdout group (e.g. 0.05 for 5%). An equally sized comparison group is sampled from the remaining traffic for measurement, so 2× this value enters the holdout experiment in total. Must be greater than 0 and at most 0.5.

Required range: x <= 0.5

hashAttribute

string

required

Attribute used to assign users to the Holdout.

targetingCondition

string

required

Targeting condition as a JSON string.

datasourceId

string

required

assignmentQueryId

string

required

goalMetrics

string[]

required

secondaryMetrics

string[]

required

variations

object[]

required

Show child attributes

environments

object

required

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

Show child attributes

linkedFeatures

object[]

required

Feature Flags held out by this Holdout. Manage these through the Feature Flag endpoints.

Show child attributes

linkedExperiments

object[]

required

Experiments held out by this Holdout. Manage these through the experiment endpoints.

Show child attributes

ownerEmail

string

The email address of the owner, when the owner can be resolved to a known user.

savedGroupTargeting

object[]

Show child attributes

statsEngine

enum<string>

Statistics engine used to analyze this Holdout.

Available options:

bayesian,

frequentist

dateStarted

string<date-time>

analysisStartDate

string<date-time>

When the Holdout entered its analysis period.

dateStopped

string<date-time>

statusUpdateSchedule

object | null

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

Show child attributes

nextScheduledStatusUpdate

object | null

The next stage transition that will run automatically.

Show child attributes

{
  "id": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "projects": [
    "<string>"
  ],
  "owner": "<string>",
  "tags": [
    "<string>"
  ],
  "archived": true,
  "trackingKey": "<string>",
  "experimentId": "<string>",
  "skipAsDefaultHoldout": true,
  "holdoutSize": -0.5,
  "hashAttribute": "<string>",
  "targetingCondition": "<string>",
  "datasourceId": "<string>",
  "assignmentQueryId": "<string>",
  "goalMetrics": [
    "<string>"
  ],
  "secondaryMetrics": [
    "<string>"
  ],
  "variations": [
    {
      "variationId": "<string>",
      "key": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "environments": {},
  "linkedFeatures": [
    {
      "id": "<string>",
      "dateAdded": "2023-11-07T05:31:56Z"
    }
  ],
  "linkedExperiments": [
    {
      "id": "<string>",
      "dateAdded": "2023-11-07T05:31:56Z"
    }
  ],
  "ownerEmail": "<string>",
  "savedGroupTargeting": [
    {
      "ids": [
        "<string>"
      ]
    }
  ],
  "dateStarted": "2023-11-07T05:31:56Z",
  "analysisStartDate": "2023-11-07T05:31:56Z",
  "dateStopped": "2023-11-07T05:31:56Z",
  "statusUpdateSchedule": {
    "startAt": "2023-11-07T05:31:56Z",
    "startAnalysisPeriodAt": "2023-11-07T05:31:56Z",
    "stopAt": "2023-11-07T05:31:56Z"
  },
  "nextScheduledStatusUpdate": {
    "date": "2023-11-07T05:31:56Z"
  }
}

Introduction

Endpoints

Models