List Holdouts for a project

1 min

GET

https://api.optimizely.com/flags/v1//projects/{project_id}/holdouts

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.

project_idintegerThe project identifier

archivedbooleanFilter the Holdouts by archived status. Set to <code>true</code> to show only archived holdouts, <code>false</code> to show only active holdouts, or omit to show both.

statusarray

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

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

pageinteger<int64>Page number for pagination

per_pageinteger<int64>The max number of items to include per page or results.

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

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

200Successful retrieval of a list of holdouts. The response includes RESTful JSON (<a href="https://restfuljson.org/" target="_blank">https://restfuljson.org/</a>) styled links. If a link is not present in the response, it indicates a user is not authorized to access the related resource.

400Malformed requests and invalid parameter names and types

401Invalid credentials

403Do not have permission to perform the operation

404Not found. No content

curl --request GET \
     --url https://api.optimizely.com/flags/v1//projects/{project_id}/holdouts \
     --header 'accept: application/json'