Get Holdout by Id

GET

/api/v2/projects/:projectKey/environments/:environmentKey/holdouts/id/:holdoutId

GET

/api/v2/projects/:projectKey/environments/:environmentKey/holdouts/id/:holdoutId

1 import requests
2 
3 url = "https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/holdouts/id/holdoutId"
4 
5 headers = {"Authorization": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

1 {
2   "_id": "string",
3   "status": "created",
4   "holdoutAmount": "string",
5   "createdAt": 1,
6   "updatedAt": 1,
7   "baseExperiment": {
8     "key": "experiment-key-123abc",
9     "name": "Example experiment",
10     "_maintainerId": "12ab3c45de678910fgh12345",
11     "_creationDate": 1654104600000,
12     "environmentKey": "string",
13     "_links": {
14       "parent": {
15         "href": "/api/v2/projects/my-project/environments/my-environment",
16         "type": "application/json"
17       },
18       "self": {
19         "href": "/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment",
20         "type": "application/json"
21       }
22     },
23     "_id": "12ab3c45de678910fgh12345",
24     "description": "An example experiment, used in testing",
25     "methodology": "bayesian",
26     "dataSource": "snowflake",
27     "archivedDate": 1654104600000,
28     "tags": [
29       "experiment",
30       "feature"
31     ],
32     "holdoutId": "f3b74309-d581-44e1-8a2b-bb2933b4fe40",
33     "currentIteration": {
34       "hypothesis": "The new button placement will increase conversion",
35       "status": "running",
36       "createdAt": 1654104600000,
37       "_id": "12ab3c45de678910fgh12345",
38       "startedAt": 1655314200000,
39       "endedAt": 1656610200000,
40       "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
41       "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
42       "canReshuffleTraffic": true,
43       "flags": {},
44       "reallocationFrequencyMillis": 3600000,
45       "version": 0,
46       "primaryMetric": {
47         "key": "metric-key-123abc",
48         "_versionId": "string",
49         "name": "My metric",
50         "kind": "custom",
51         "_links": {
52           "self": {
53             "href": "/api/v2/metrics/my-project/my-metric",
54             "type": "application/json"
55           }
56         },
57         "isGroup": true,
58         "isNumeric": true,
59         "eventKey": "event-key-123abc",
60         "metrics": [
61           {
62             "key": "metric-key-123abc",
63             "name": "Example metric",
64             "kind": "custom",
65             "_links": {
66               "self": {
67                 "href": "/api/v2/metrics/my-project/my-metric",
68                 "type": "application/json"
69               }
70             },
71             "_versionId": "version-id-123abc",
72             "isNumeric": true,
73             "unitAggregationType": "sum",
74             "eventKey": "event-key-123abc",
75             "nameInGroup": "Step 1",
76             "randomizationUnits": [
77               "user"
78             ]
79           }
80         ]
81       },
82       "primarySingleMetric": {
83         "key": "metric-key-123abc",
84         "name": "Example metric",
85         "kind": "custom",
86         "_links": {
87           "self": {
88             "href": "/api/v2/metrics/my-project/my-metric",
89             "type": "application/json"
90           }
91         },
92         "_versionId": "version-id-123abc",
93         "isNumeric": true,
94         "unitAggregationType": "sum",
95         "eventKey": "event-key-123abc"
96       },
97       "primaryFunnel": {
98         "key": "metric-group-key-123abc",
99         "name": "My metric group",
100         "kind": "funnel",
101         "_links": {
102           "parent": {
103             "href": "/api/v2/projects/my-project",
104             "type": "application/json"
105           },
106           "self": {
107             "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
108             "type": "application/json"
109           }
110         },
111         "metrics": [
112           {
113             "key": "metric-key-123abc",
114             "name": "Example metric",
115             "kind": "custom",
116             "_links": {
117               "self": {
118                 "href": "/api/v2/metrics/my-project/my-metric",
119                 "type": "application/json"
120               }
121             },
122             "_versionId": "version-id-123abc",
123             "isNumeric": true,
124             "unitAggregationType": "sum",
125             "eventKey": "event-key-123abc",
126             "nameInGroup": "Step 1",
127             "randomizationUnits": [
128               "user"
129             ]
130           }
131         ]
132       },
133       "randomizationUnit": "user",
134       "attributes": [
135         "string"
136       ],
137       "treatments": [
138         {
139           "name": "Treatment 1",
140           "allocationPercent": "10",
141           "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
142           "baseline": true,
143           "parameters": [
144             {
145               "variationId": "string",
146               "flagKey": "string"
147             }
148           ]
149         }
150       ],
151       "metrics": [
152         {
153           "key": "metric-key-123abc",
154           "_versionId": "string",
155           "name": "My metric",
156           "kind": "custom",
157           "_links": {
158             "self": {
159               "href": "/api/v2/metrics/my-project/my-metric",
160               "type": "application/json"
161             }
162           },
163           "isGroup": true,
164           "isNumeric": true,
165           "eventKey": "event-key-123abc",
166           "metrics": [
167             {
168               "key": "metric-key-123abc",
169               "name": "Example metric",
170               "kind": "custom",
171               "_links": {
172                 "self": {
173                   "href": "/api/v2/metrics/my-project/my-metric",
174                   "type": "application/json"
175                 }
176               },
177               "_versionId": "version-id-123abc",
178               "isNumeric": true,
179               "unitAggregationType": "sum",
180               "eventKey": "event-key-123abc",
181               "nameInGroup": "Step 1",
182               "randomizationUnits": [
183                 "user"
184               ]
185             }
186           ]
187         }
188       ],
189       "layerSnapshot": {
190         "key": "checkout-flow",
191         "name": "Checkout Flow",
192         "reservationPercent": 10,
193         "otherReservationPercent": 70
194       },
195       "covariateInfo": {
196         "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
197         "fileName": "covariate.csv",
198         "createdAt": 1654104600000
199       },
200       "secondaryMetrics": [
201         {
202           "key": "metric-key-123abc",
203           "name": "Example metric",
204           "kind": "custom",
205           "_links": {
206             "self": {
207               "href": "/api/v2/metrics/my-project/my-metric",
208               "type": "application/json"
209             }
210           },
211           "_versionId": "version-id-123abc",
212           "isNumeric": true,
213           "unitAggregationType": "sum",
214           "eventKey": "event-key-123abc"
215         }
216       ]
217     },
218     "type": "experiment",
219     "draftIteration": {
220       "hypothesis": "The new button placement will increase conversion",
221       "status": "running",
222       "createdAt": 1654104600000,
223       "_id": "12ab3c45de678910fgh12345",
224       "startedAt": 1655314200000,
225       "endedAt": 1656610200000,
226       "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
227       "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
228       "canReshuffleTraffic": true,
229       "flags": {},
230       "reallocationFrequencyMillis": 3600000,
231       "version": 0,
232       "primaryMetric": {
233         "key": "metric-key-123abc",
234         "_versionId": "string",
235         "name": "My metric",
236         "kind": "custom",
237         "_links": {
238           "self": {
239             "href": "/api/v2/metrics/my-project/my-metric",
240             "type": "application/json"
241           }
242         },
243         "isGroup": true,
244         "isNumeric": true,
245         "eventKey": "event-key-123abc",
246         "metrics": [
247           {
248             "key": "metric-key-123abc",
249             "name": "Example metric",
250             "kind": "custom",
251             "_links": {
252               "self": {
253                 "href": "/api/v2/metrics/my-project/my-metric",
254                 "type": "application/json"
255               }
256             },
257             "_versionId": "version-id-123abc",
258             "isNumeric": true,
259             "unitAggregationType": "sum",
260             "eventKey": "event-key-123abc",
261             "nameInGroup": "Step 1",
262             "randomizationUnits": [
263               "user"
264             ]
265           }
266         ]
267       },
268       "primarySingleMetric": {
269         "key": "metric-key-123abc",
270         "name": "Example metric",
271         "kind": "custom",
272         "_links": {
273           "self": {
274             "href": "/api/v2/metrics/my-project/my-metric",
275             "type": "application/json"
276           }
277         },
278         "_versionId": "version-id-123abc",
279         "isNumeric": true,
280         "unitAggregationType": "sum",
281         "eventKey": "event-key-123abc"
282       },
283       "primaryFunnel": {
284         "key": "metric-group-key-123abc",
285         "name": "My metric group",
286         "kind": "funnel",
287         "_links": {
288           "parent": {
289             "href": "/api/v2/projects/my-project",
290             "type": "application/json"
291           },
292           "self": {
293             "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
294             "type": "application/json"
295           }
296         },
297         "metrics": [
298           {
299             "key": "metric-key-123abc",
300             "name": "Example metric",
301             "kind": "custom",
302             "_links": {
303               "self": {
304                 "href": "/api/v2/metrics/my-project/my-metric",
305                 "type": "application/json"
306               }
307             },
308             "_versionId": "version-id-123abc",
309             "isNumeric": true,
310             "unitAggregationType": "sum",
311             "eventKey": "event-key-123abc",
312             "nameInGroup": "Step 1",
313             "randomizationUnits": [
314               "user"
315             ]
316           }
317         ]
318       },
319       "randomizationUnit": "user",
320       "attributes": [
321         "string"
322       ],
323       "treatments": [
324         {
325           "name": "Treatment 1",
326           "allocationPercent": "10",
327           "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
328           "baseline": true,
329           "parameters": [
330             {
331               "variationId": "string",
332               "flagKey": "string"
333             }
334           ]
335         }
336       ],
337       "metrics": [
338         {
339           "key": "metric-key-123abc",
340           "_versionId": "string",
341           "name": "My metric",
342           "kind": "custom",
343           "_links": {
344             "self": {
345               "href": "/api/v2/metrics/my-project/my-metric",
346               "type": "application/json"
347             }
348           },
349           "isGroup": true,
350           "isNumeric": true,
351           "eventKey": "event-key-123abc",
352           "metrics": [
353             {
354               "key": "metric-key-123abc",
355               "name": "Example metric",
356               "kind": "custom",
357               "_links": {
358                 "self": {
359                   "href": "/api/v2/metrics/my-project/my-metric",
360                   "type": "application/json"
361                 }
362               },
363               "_versionId": "version-id-123abc",
364               "isNumeric": true,
365               "unitAggregationType": "sum",
366               "eventKey": "event-key-123abc",
367               "nameInGroup": "Step 1",
368               "randomizationUnits": [
369                 "user"
370               ]
371             }
372           ]
373         }
374       ],
375       "layerSnapshot": {
376         "key": "checkout-flow",
377         "name": "Checkout Flow",
378         "reservationPercent": 10,
379         "otherReservationPercent": 70
380       },
381       "covariateInfo": {
382         "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
383         "fileName": "covariate.csv",
384         "createdAt": 1654104600000
385       },
386       "secondaryMetrics": [
387         {
388           "key": "metric-key-123abc",
389           "name": "Example metric",
390           "kind": "custom",
391           "_links": {
392             "self": {
393               "href": "/api/v2/metrics/my-project/my-metric",
394               "type": "application/json"
395             }
396           },
397           "_versionId": "version-id-123abc",
398           "isNumeric": true,
399           "unitAggregationType": "sum",
400           "eventKey": "event-key-123abc"
401         }
402       ]
403     },
404     "previousIterations": [
405       {
406         "hypothesis": "The new button placement will increase conversion",
407         "status": "running",
408         "createdAt": 1654104600000,
409         "_id": "12ab3c45de678910fgh12345",
410         "startedAt": 1655314200000,
411         "endedAt": 1656610200000,
412         "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
413         "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
414         "canReshuffleTraffic": true,
415         "flags": {},
416         "reallocationFrequencyMillis": 3600000,
417         "version": 0,
418         "primaryMetric": {
419           "key": "metric-key-123abc",
420           "_versionId": "string",
421           "name": "My metric",
422           "kind": "custom",
423           "_links": {
424             "self": {
425               "href": "/api/v2/metrics/my-project/my-metric",
426               "type": "application/json"
427             }
428           },
429           "isGroup": true,
430           "isNumeric": true,
431           "eventKey": "event-key-123abc",
432           "metrics": [
433             {
434               "key": "metric-key-123abc",
435               "name": "Example metric",
436               "kind": "custom",
437               "_links": {
438                 "self": {
439                   "href": "/api/v2/metrics/my-project/my-metric",
440                   "type": "application/json"
441                 }
442               },
443               "_versionId": "version-id-123abc",
444               "isNumeric": true,
445               "unitAggregationType": "sum",
446               "eventKey": "event-key-123abc",
447               "nameInGroup": "Step 1",
448               "randomizationUnits": [
449                 "user"
450               ]
451             }
452           ]
453         },
454         "primarySingleMetric": {
455           "key": "metric-key-123abc",
456           "name": "Example metric",
457           "kind": "custom",
458           "_links": {
459             "self": {
460               "href": "/api/v2/metrics/my-project/my-metric",
461               "type": "application/json"
462             }
463           },
464           "_versionId": "version-id-123abc",
465           "isNumeric": true,
466           "unitAggregationType": "sum",
467           "eventKey": "event-key-123abc"
468         },
469         "primaryFunnel": {
470           "key": "metric-group-key-123abc",
471           "name": "My metric group",
472           "kind": "funnel",
473           "_links": {
474             "parent": {
475               "href": "/api/v2/projects/my-project",
476               "type": "application/json"
477             },
478             "self": {
479               "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
480               "type": "application/json"
481             }
482           },
483           "metrics": [
484             {
485               "key": "metric-key-123abc",
486               "name": "Example metric",
487               "kind": "custom",
488               "_links": {
489                 "self": {
490                   "href": "/api/v2/metrics/my-project/my-metric",
491                   "type": "application/json"
492                 }
493               },
494               "_versionId": "version-id-123abc",
495               "isNumeric": true,
496               "unitAggregationType": "sum",
497               "eventKey": "event-key-123abc",
498               "nameInGroup": "Step 1",
499               "randomizationUnits": [
500                 "user"
501               ]
502             }
503           ]
504         },
505         "randomizationUnit": "user",
506         "attributes": [
507           "string"
508         ],
509         "treatments": [
510           {
511             "name": "Treatment 1",
512             "allocationPercent": "10",
513             "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
514             "baseline": true,
515             "parameters": [
516               {
517                 "variationId": "string",
518                 "flagKey": "string"
519               }
520             ]
521           }
522         ],
523         "metrics": [
524           {
525             "key": "metric-key-123abc",
526             "_versionId": "string",
527             "name": "My metric",
528             "kind": "custom",
529             "_links": {
530               "self": {
531                 "href": "/api/v2/metrics/my-project/my-metric",
532                 "type": "application/json"
533               }
534             },
535             "isGroup": true,
536             "isNumeric": true,
537             "eventKey": "event-key-123abc",
538             "metrics": [
539               {
540                 "key": "metric-key-123abc",
541                 "name": "Example metric",
542                 "kind": "custom",
543                 "_links": {
544                   "self": {
545                     "href": "/api/v2/metrics/my-project/my-metric",
546                     "type": "application/json"
547                   }
548                 },
549                 "_versionId": "version-id-123abc",
550                 "isNumeric": true,
551                 "unitAggregationType": "sum",
552                 "eventKey": "event-key-123abc",
553                 "nameInGroup": "Step 1",
554                 "randomizationUnits": [
555                   "user"
556                 ]
557               }
558             ]
559           }
560         ],
561         "layerSnapshot": {
562           "key": "checkout-flow",
563           "name": "Checkout Flow",
564           "reservationPercent": 10,
565           "otherReservationPercent": 70
566         },
567         "covariateInfo": {
568           "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
569           "fileName": "covariate.csv",
570           "createdAt": 1654104600000
571         },
572         "secondaryMetrics": [
573           {
574             "key": "metric-key-123abc",
575             "name": "Example metric",
576             "kind": "custom",
577             "_links": {
578               "self": {
579                 "href": "/api/v2/metrics/my-project/my-metric",
580                 "type": "application/json"
581               }
582             },
583             "_versionId": "version-id-123abc",
584             "isNumeric": true,
585             "unitAggregationType": "sum",
586             "eventKey": "event-key-123abc"
587           }
588         ]
589       }
590     ],
591     "analysisConfig": {
592       "bayesianThreshold": "string",
593       "significanceThreshold": "string",
594       "testDirection": "string",
595       "multipleComparisonCorrectionMethod": "bonferroni",
596       "multipleComparisonCorrectionScope": "variations",
597       "sequentialTestingEnabled": true
598     }
599   },
600   "description": "string",
601   "experiments": [
602     {
603       "key": "string",
604       "name": "string",
605       "environment": "string"
606     }
607   ]
608 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

holdoutIdstringRequiredformat: "string"

The holdout experiment ID

Response

Holdout response

_idstring

statusenum

Allowed values:

holdoutAmountstring

The percentage of traffic allocated to this holdout.

createdAtlong

updatedAtlong

baseExperimentobject

descriptionstring

experimentslist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error