Access tokens6

Account members7

Account usage (beta)21

AI Configs30

Announcements4

Applications (beta)7

Approvals13

Approvals (beta)4

Audit log4

Code references13

Context settings1

Contexts10

Custom roles5

Data Export destinations7

Environments7

Experiments7

Feature flags14

Feature flags (beta)2

Flag import configurations (beta)6

Flag links (beta)4

Flag triggers5

Follow flags4

Holdouts (beta)5

Insights charts (beta)5

Insights deployments (beta)4

Insights flag events (beta)1

Insights pull requests (beta)1

Insights repositories (beta)3

Insights scores (beta)6

Integration audit log subscriptions5

Integration delivery configurations (beta)7

Integrations (beta)5

Layers3

Metrics5

Metrics (beta)5

OAuth2 Clients5

Other5

Persistent store integrations (beta)5

Projects8

Relay Proxy configurations6

Release pipelines (beta)6

Release policies (beta)6

Releases (beta)5

Scheduled changes5

Segments18

Tags1

Teams8

Teams (beta)1

User settings5

Users4

Users (beta)1

Views (beta)9

Webhooks5

Workflow templates3

Workflows4

Holdouts (beta)

Get Holdout by Id

get/api/v2/projects/{projectKey}/environments/{environmentKey}/holdouts/id/{holdoutId}

Path parameters

projectKeystring string required

The project key

environmentKeystring string required

The environment key

holdoutIdstring string required

The holdout experiment ID

Response

Holdout response

_idstring required

status'created' | 'enabled' | 'running' | 'ended' required

descriptionstring

holdoutAmountstring required

The percentage of traffic allocated to this holdout.

createdAtinteger required

updatedAtinteger required

Example response

{
  "baseExperiment": {
    "_id": "12ab3c45de678910fgh12345",
    "key": "experiment-key-123abc",
    "name": "Example experiment",
    "description": "An example experiment, used in testing",
    "_maintainerId": "12ab3c45de678910fgh12345",
    "tags": [
      "experiment",
      "feature"
    ],
    "_links": {
      "parent": {
        "href": "/api/v2/projects/my-project/environments/my-environment",
        "type": "application/json"
      },
      "self": {
        "href": "/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment",
        "type": "application/json"
      }
    },
    "holdoutId": "f3b74309-d581-44e1-8a2b-bb2933b4fe40",
    "currentIteration": {
      "_id": "12ab3c45de678910fgh12345",
      "hypothesis": "The new button placement will increase conversion",
      "status": "running",
      "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
      "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
      "canReshuffleTraffic": true,
      "reallocationFrequencyMillis": 3600000,
      "primaryMetric": {
        "key": "metric-key-123abc",
        "name": "My metric",
        "kind": "custom",
        "isNumeric": true,
        "eventKey": "event-key-123abc",
        "_links": {
          "self": {
            "href": "/api/v2/metrics/my-project/my-metric",
            "type": "application/json"
          }
        },
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "version-id-123abc",
            "name": "Example metric",
            "kind": "custom",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "nameInGroup": "Step 1",
            "randomizationUnits": [
              "user"
            ]
          }
        ]
      },
      "primarySingleMetric": {
        "key": "metric-key-123abc",
        "_versionId": "version-id-123abc",
        "name": "Example metric",
        "kind": "custom",
        "isNumeric": true,
        "unitAggregationType": "sum",
        "eventKey": "event-key-123abc",
        "_links": {
          "self": {
            "href": "/api/v2/metrics/my-project/my-metric",
            "type": "application/json"
          }
        }
      },
      "primaryFunnel": {
        "key": "metric-group-key-123abc",
        "name": "My metric group",
        "kind": "funnel",
        "_links": {
          "parent": {
            "href": "/api/v2/projects/my-project",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
            "type": "application/json"
          }
        },
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "version-id-123abc",
            "name": "Example metric",
            "kind": "custom",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "nameInGroup": "Step 1",
            "randomizationUnits": [
              "user"
            ]
          }
        ]
      },
      "randomizationUnit": "user",
      "treatments": [
        {
          "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
          "name": "Treatment 1",
          "allocationPercent": "10",
          "baseline": true
        }
      ],
      "secondaryMetrics": [
        {
          "key": "metric-key-123abc",
          "_versionId": "version-id-123abc",
          "name": "Example metric",
          "kind": "custom",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          }
        }
      ],
      "metrics": [
        {
          "key": "metric-key-123abc",
          "name": "My metric",
          "kind": "custom",
          "isNumeric": true,
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "_versionId": "version-id-123abc",
              "name": "Example metric",
              "kind": "custom",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        }
      ],
      "layerSnapshot": {
        "key": "checkout-flow",
        "name": "Checkout Flow",
        "reservationPercent": 10,
        "otherReservationPercent": 70
      }
    },
    "draftIteration": {
      "_id": "12ab3c45de678910fgh12345",
      "hypothesis": "The new button placement will increase conversion",
      "status": "running",
      "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
      "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
      "canReshuffleTraffic": true,
      "reallocationFrequencyMillis": 3600000,
      "primaryMetric": {
        "key": "metric-key-123abc",
        "name": "My metric",
        "kind": "custom",
        "isNumeric": true,
        "eventKey": "event-key-123abc",
        "_links": {
          "self": {
            "href": "/api/v2/metrics/my-project/my-metric",
            "type": "application/json"
          }
        },
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "version-id-123abc",
            "name": "Example metric",
            "kind": "custom",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "nameInGroup": "Step 1",
            "randomizationUnits": [
              "user"
            ]
          }
        ]
      },
      "primarySingleMetric": {
        "key": "metric-key-123abc",
        "_versionId": "version-id-123abc",
        "name": "Example metric",
        "kind": "custom",
        "isNumeric": true,
        "unitAggregationType": "sum",
        "eventKey": "event-key-123abc",
        "_links": {
          "self": {
            "href": "/api/v2/metrics/my-project/my-metric",
            "type": "application/json"
          }
        }
      },
      "primaryFunnel": {
        "key": "metric-group-key-123abc",
        "name": "My metric group",
        "kind": "funnel",
        "_links": {
          "parent": {
            "href": "/api/v2/projects/my-project",
            "type": "application/json"
          },
          "self": {
            "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
            "type": "application/json"
          }
        },
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "version-id-123abc",
            "name": "Example metric",
            "kind": "custom",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "nameInGroup": "Step 1",
            "randomizationUnits": [
              "user"
            ]
          }
        ]
      },
      "randomizationUnit": "user",
      "treatments": [
        {
          "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
          "name": "Treatment 1",
          "allocationPercent": "10",
          "baseline": true
        }
      ],
      "secondaryMetrics": [
        {
          "key": "metric-key-123abc",
          "_versionId": "version-id-123abc",
          "name": "Example metric",
          "kind": "custom",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          }
        }
      ],
      "metrics": [
        {
          "key": "metric-key-123abc",
          "name": "My metric",
          "kind": "custom",
          "isNumeric": true,
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "_versionId": "version-id-123abc",
              "name": "Example metric",
              "kind": "custom",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        }
      ],
      "layerSnapshot": {
        "key": "checkout-flow",
        "name": "Checkout Flow",
        "reservationPercent": 10,
        "otherReservationPercent": 70
      }
    },
    "previousIterations": [
      {
        "_id": "12ab3c45de678910fgh12345",
        "hypothesis": "The new button placement will increase conversion",
        "status": "running",
        "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
        "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
        "canReshuffleTraffic": true,
        "reallocationFrequencyMillis": 3600000,
        "primaryMetric": {
          "key": "metric-key-123abc",
          "name": "My metric",
          "kind": "custom",
          "isNumeric": true,
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "_versionId": "version-id-123abc",
              "name": "Example metric",
              "kind": "custom",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "primarySingleMetric": {
          "key": "metric-key-123abc",
          "_versionId": "version-id-123abc",
          "name": "Example metric",
          "kind": "custom",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          }
        },
        "primaryFunnel": {
          "key": "metric-group-key-123abc",
          "name": "My metric group",
          "kind": "funnel",
          "_links": {
            "parent": {
              "href": "/api/v2/projects/my-project",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "_versionId": "version-id-123abc",
              "name": "Example metric",
              "kind": "custom",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "randomizationUnit": "user",
        "treatments": [
          {
            "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
            "name": "Treatment 1",
            "allocationPercent": "10",
            "baseline": true
          }
        ],
        "secondaryMetrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "version-id-123abc",
            "name": "Example metric",
            "kind": "custom",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            }
          }
        ],
        "metrics": [
          {
            "key": "metric-key-123abc",
            "name": "My metric",
            "kind": "custom",
            "isNumeric": true,
            "eventKey": "event-key-123abc",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "metrics": [
              {
                "key": "metric-key-123abc",
                "_versionId": "version-id-123abc",
                "name": "Example metric",
                "kind": "custom",
                "isNumeric": true,
                "unitAggregationType": "sum",
                "eventKey": "event-key-123abc",
                "_links": {
                  "self": {
                    "href": "/api/v2/metrics/my-project/my-metric",
                    "type": "application/json"
                  }
                },
                "nameInGroup": "Step 1",
                "randomizationUnits": [
                  "user"
                ]
              }
            ]
          }
        ],
        "layerSnapshot": {
          "key": "checkout-flow",
          "name": "Checkout Flow",
          "reservationPercent": 10,
          "otherReservationPercent": 70
        }
      }
    ]
  }
}

Changes

Changed in 2 of the 5 revisions of this API.1828

Feb 28, 202669c5c9aafe78928See the full diff
- ●
  added the new not_started enum value to the baseExperiment/currentIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new not_started enum value to the baseExperiment/draftIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new not_started enum value to the baseExperiment/previousIterations/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new running enum value to the baseExperiment/currentIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new running enum value to the baseExperiment/draftIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new running enum value to the baseExperiment/previousIterations/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new stopped enum value to the baseExperiment/currentIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new stopped enum value to the baseExperiment/draftIteration/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new stopped enum value to the baseExperiment/previousIterations/items/status response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property baseExperiment/currentIteration/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/metrics/items/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/primaryFunnel/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/primaryMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/primaryMetric/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/primarySingleMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/reallocationFrequencyMillis to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/secondaryMetrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/currentIteration/version to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/metrics/items/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/primaryFunnel/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/primaryMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/primaryMetric/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/primarySingleMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/reallocationFrequencyMillis to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/secondaryMetrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/draftIteration/version to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/metrics/items/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/primaryFunnel/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/primaryMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/primaryMetric/metrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/primarySingleMetric/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/reallocationFrequencyMillis to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/secondaryMetrics/items/eventKey to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/previousIterations/items/version to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property baseExperiment/tags to the response with the 200 status
  response-optional-property-added
This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 2025b2724c5174d19See the full diff
- ●
  added the new guardrail enum value to the baseExperiment/currentIteration/metrics/items/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/currentIteration/primaryFunnel/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/currentIteration/primaryMetric/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/draftIteration/metrics/items/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/draftIteration/primaryFunnel/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/draftIteration/primaryMetric/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/previousIterations/items/metrics/items/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/previousIterations/items/primaryFunnel/kind response property for the response status 200
  response-property-enum-value-added
- ●
  added the new guardrail enum value to the baseExperiment/previousIterations/items/primaryMetric/kind response property for the response status 200
  response-property-enum-value-added

Full history