Available for customers using Experimentation
Holdouts are available to customers using Experimentation.
This feature is in beta
To use this feature, pass in a header including the
LD-API-Version
key with value set tobeta
. Use this header with each call. To learn more, read Beta resources.Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.
Holdouts let you exclude a percentage of your audience from your Experimentation program. This enables you to see the overall effect of your experiments on your customer base, and helps determine how effective the experiments you're running are.
Using the holdouts API, you can create, delete, and manage holdouts. To learn more, read Holdouts.
All Holdouts response
Invalid request
Invalid access token
Forbidden
Rate limited
{- "items": [
- {
- "_id": "string",
- "key": "string",
- "name": "string",
- "status": "string",
- "createdAt": 0,
- "updatedAt": 0,
- "experiments": [
- {
- "key": "string",
- "name": "string",
- "environment": "string"
}
]
}
], - "_links": {
- "self": {
- "href": "/api/v2/my-project/environments/my-environment/holdouts?limit=20",
- "type": "application/json"
}
}, - "total_count": 0
}
Create a new holdout in the specified project.
Holdout response
Invalid request
{- "name": "holdout-one-name",
- "key": "holdout-key",
- "description": "My holdout-one description",
- "randomizationunit": "user",
- "attributes": [
- "country",
- "device",
- "os"
], - "holdoutamount": "10",
- "primarymetrickey": "metric-key-123abc",
- "metrics": [
- {
- "key": "metric-key-123abc",
- "isGroup": true,
- "primary": true
}
], - "prerequisiteflagkey": "flag-key-123abc"
}
{- "_id": "string",
- "status": "created",
- "description": "string",
- "holdoutAmount": "string",
- "createdAt": 0,
- "updatedAt": 0,
- "baseExperiment": {
- "_id": "12ab3c45de678910fgh12345",
- "key": "experiment-key-123abc",
- "name": "Example experiment",
- "description": "An example experiment, used in testing",
- "_maintainerId": "12ab3c45de678910fgh12345",
- "_creationDate": 0,
- "environmentKey": "string",
- "archivedDate": 0,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}
]
}, - "experiments": [
- {
- "key": "string",
- "name": "string",
- "environment": "string"
}
]
}
Holdout response
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
{- "_id": "string",
- "status": "created",
- "description": "string",
- "holdoutAmount": "string",
- "createdAt": 0,
- "updatedAt": 0,
- "baseExperiment": {
- "_id": "12ab3c45de678910fgh12345",
- "key": "experiment-key-123abc",
- "name": "Example experiment",
- "description": "An example experiment, used in testing",
- "_maintainerId": "12ab3c45de678910fgh12345",
- "_creationDate": 0,
- "environmentKey": "string",
- "archivedDate": 0,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}
]
}, - "experiments": [
- {
- "key": "string",
- "name": "string",
- "environment": "string"
}
]
}
Get details about a holdout.
LaunchDarkly supports the following fields for expanding the "Get holdout" response. By default, these fields are not included in the response.
To expand the response, append the expand
query parameter and add a comma-separated list with any of the following fields:
draftIteration
includes the iteration which has not been started yet, if any, for this holdout.previousIterations
includes all iterations prior to the current iteration, for this holdout. By default only the current iteration is included in the response.rel-draftIteration
includes the iteration which has not been started yet, if any, for the experiments related to this holdout.rel-metrics
includes metrics for experiments related to this holdout.rel-previousIterations
includes all iterations prior to the current iteration, for the experiments related to this holdout.rel-secondaryMetrics
includes secondary metrics for experiments related to this holdout.rel-treatments
includes all treatment and parameter details for experiments related to this holdout.secondaryMetrics
includes secondary metrics for this holdout. By default only the primary metric is included in the response.treatments
includes all treatment and parameter details for this holdout. By default treatment data is not included in the response.For example, expand=draftIteration,rel-draftIteration
includes the draftIteration
and rel-draftIteration
fields in the response. If fields that you request with the expand
query parameter are empty, they are not included in the response.
HoldoutDetail response with full experiments
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
{- "_id": "string",
- "status": "created",
- "description": "string",
- "holdoutAmount": "string",
- "isDirty": true,
- "createdAt": 0,
- "updatedAt": 0,
- "baseExperiment": {
- "_id": "12ab3c45de678910fgh12345",
- "key": "experiment-key-123abc",
- "name": "Example experiment",
- "description": "An example experiment, used in testing",
- "_maintainerId": "12ab3c45de678910fgh12345",
- "_creationDate": 0,
- "environmentKey": "string",
- "archivedDate": 0,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}
]
}, - "relatedExperiments": [
- {
- "_id": "12ab3c45de678910fgh12345",
- "key": "experiment-key-123abc",
- "name": "Example experiment",
- "description": "An example experiment, used in testing",
- "_maintainerId": "12ab3c45de678910fgh12345",
- "_creationDate": 0,
- "environmentKey": "string",
- "archivedDate": 0,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}, - "draftIteration": {
- "_id": "12ab3c45de678910fgh12345",
- "hypothesis": "The new button placement will increase conversion",
- "status": "running",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}, - "previousIterations": [
- {
- "_id": "12ab3c45de678910fgh12345",
- "hypothesis": "The new button placement will increase conversion",
- "status": "running",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}, - "primarySingleMetric": {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- null
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- null
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}
]
}
]
}
Updates an existing holdout, and returns the updated holdout. Updating holdouts uses the semantic patch format.
To make a semantic patch request, you must append domain-model=launchdarkly.semanticpatch
to your Content-Type
header. To learn more, read Updates using semantic patch.
Semantic patch requests support the following kind
instructions for updating holdouts.
Ends a holdout.
None.
Here's an example:
{
"comment": "Optional comment describing why the holdout is ending",
"instructions": [{
"kind": "endHoldout"
}]
}
Removes an experiment from a holdout.
value
: The key of the experiment to removeHere's an example:
{
"comment": "Optional comment describing the change",
"instructions": [{
"kind": "removeExperiment",
"value": "experiment-key"
}]
}
Updates the description of the holdout.
value
: The new description.Here's an example:
{
"comment": "Optional comment describing the update",
"instructions": [{
"kind": "updateDescription",
"value": "Updated holdout description"
}]
}
Updates the name of the holdout.
value
: The new name.Here's an example:
{
"comment": "Optional comment describing the update",
"instructions": [{
"kind": "updateName",
"value": "Updated holdout name"
}]
}
Holdout response
Invalid request
Invalid access token
Forbidden
Invalid resource identifier
Rate limited
{- "comment": "Optional comment describing the update",
- "instructions": [
- {
- "kind": "updateName",
- "value": "Updated holdout name"
}
]
}
{- "_id": "string",
- "status": "created",
- "description": "string",
- "holdoutAmount": "string",
- "createdAt": 0,
- "updatedAt": 0,
- "baseExperiment": {
- "_id": "12ab3c45de678910fgh12345",
- "key": "experiment-key-123abc",
- "name": "Example experiment",
- "description": "An example experiment, used in testing",
- "_maintainerId": "12ab3c45de678910fgh12345",
- "_creationDate": 0,
- "environmentKey": "string",
- "archivedDate": 0,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": "string",
- "flagKey": "string"
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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",
- "createdAt": 0,
- "startedAt": 0,
- "endedAt": 0,
- "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
- "canReshuffleTraffic": true,
- "flags": {
- "property1": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}, - "property2": {
- "targetingRule": "fallthrough",
- "targetingRuleDescription": "Customers who live in Canada",
- "targetingRuleClauses": [
- null
], - "flagConfigVersion": 12,
- "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05",
- "_links": {
- "self": {
- "href": "/api/v2/flags/my-project/my-flag",
- "type": "application/json"
}
}
}
}, - "primaryMetric": {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_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,
- "_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,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "nameInGroup": "Step 1",
- "randomizationUnits": [
- "user"
]
}
]
}, - "randomizationUnit": "user",
- "attributes": [
- "string"
], - "treatments": [
- {
- "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
- "name": "Treatment 1",
- "allocationPercent": "10",
- "baseline": true,
- "parameters": [
- {
- "variationId": null,
- "flagKey": null
}
]
}
], - "secondaryMetrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "version-id-123abc",
- "name": "Example metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}
}
], - "metrics": [
- {
- "key": "metric-key-123abc",
- "_versionId": "string",
- "name": "My metric",
- "kind": "custom",
- "isNumeric": true,
- "_links": {
- "self": {
- "href": "/api/v2/metrics/my-project/my-metric",
- "type": "application/json"
}
}, - "isGroup": true,
- "metrics": [
- {
- "key": null,
- "_versionId": null,
- "name": null,
- "kind": null,
- "isNumeric": null,
- "_links": { },
- "nameInGroup": null,
- "randomizationUnits": [ ]
}
]
}
], - "layerSnapshot": {
- "key": "checkout-flow",
- "name": "Checkout Flow",
- "reservationPercent": 10,
- "otherReservationPercent": 70
}
}
]
}, - "experiments": [
- {
- "key": "string",
- "name": "string",
- "environment": "string"
}
]
}