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

Fetch a single Holdout

Retrieves detailed information about a specific holdout by its unique ID within a project.

What you'll get:

  • Complete holdout configuration including traffic allocation, status, and settings
  • Associated experiment rules and their current states
  • Audience conditions and targeting criteria (if configured)
  • Metric tracking configuration and current values
  • Lifecycle timestamps (created, updated, started, ended)
  • RESTful links for related operations (update, delete, archive, etc.)

Holdout States:

  • Draft: Holdout is configured but not yet active
  • Running: Currently excluding traffic from experiments
  • Concluded: Finished collecting data, results available for analysis

Use Cases:

  • View complete holdout configuration before making changes
  • Monitor current status and performance metrics
  • Access experiment rules affected by this holdout
  • Retrieve data for analysis and reporting
  • Verify permissions for management operations via included links

This operation corresponds to the url or fetch_holdout_url property found in holdout list responses.

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

The project identifier

integer
required

The holdout identifier

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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