The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Dev guideRecipesAPI ReferenceChangelog
Dev guideAPI ReferenceRecipesChangelogUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

List Holdouts for a project

Get a list of Holdouts within a Project.

Holdouts are experiments that reserve a portion of your traffic to measure the impact of your feature flags and experiments. They help establish a control group by excluding a percentage of users from seeing any experiments, allowing you to measure the overall impact of your experimentation program.

You can use query parameters to filter and sort the response. Holdouts can be in different states (draft, running, concluded) and can be scoped globally or locally within your project.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The project identifier

Query Params
boolean

Filter the Holdouts by archived status. Set to true to show only archived holdouts, false to show only active holdouts, or omit to show both.

status
array of objects

Filter the Holdouts by status. Can be one or multiple values from: draft, running, or concluded. Multiple statuses can be provided as an array.

status
string

Search for Holdouts by name, description, or key. Performs a case-insensitive substring match on the holdout name, description, and key fields.

sort
array of strings

Sort the Holdouts by one or more attributes. Use format attribute:direction where direction is either asc or desc. Multiple sort criteria are applied from left to right.

sort
int64

Page number for pagination

int64

The max number of items to include per page or results.

string

Pagination page token. Implements prev, next, last, first

integer

Number of previous and next page links to supply for the request (defaults to 1).

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

Not found. No content

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json