Get holdout

GET

/api/v2/projects/:projectKey/environments/:environmentKey/holdouts/:holdoutKey

GET

/api/v2/projects/:projectKey/environments/:environmentKey/holdouts/:holdoutKey

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

Try it

1 {
2   "_id": "_id",
3   "status": "created",
4   "holdoutAmount": "holdoutAmount",
5   "createdAt": 1000000,
6   "updatedAt": 1000000,
7   "baseExperiment": {
8     "key": "experiment-key-123abc",
9     "name": "Example experiment",
10     "_maintainerId": "12ab3c45de678910fgh12345",
11     "_creationDate": 1000000,
12     "environmentKey": "environmentKey",
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     "archivedDate": 1000000,
26     "tags": [
27       "experiment",
28       "feature"
29     ],
30     "holdoutId": "f3b74309-d581-44e1-8a2b-bb2933b4fe40",
31     "currentIteration": {
32       "hypothesis": "The new button placement will increase conversion",
33       "status": "running",
34       "createdAt": 1000000,
35       "_id": "12ab3c45de678910fgh12345",
36       "startedAt": 1000000,
37       "endedAt": 1000000,
38       "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
39       "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
40       "canReshuffleTraffic": true,
41       "flags": {
42         "key": {
43           "_links": {
44             "self": {
45               "href": "/api/v2/flags/my-project/my-flag",
46               "type": "application/json"
47             }
48           },
49           "targetingRule": "fallthrough",
50           "targetingRuleDescription": "Customers who live in Canada",
51           "flagConfigVersion": 12,
52           "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
53         }
54       },
55       "reallocationFrequencyMillis": 3600000,
56       "version": 0,
57       "primaryMetric": {
58         "key": "metric-key-123abc",
59         "_versionId": "_versionId",
60         "name": "My metric",
61         "kind": "pageview",
62         "_links": {
63           "self": {
64             "href": "/api/v2/metrics/my-project/my-metric",
65             "type": "application/json"
66           }
67         },
68         "isGroup": true,
69         "isNumeric": true,
70         "eventKey": "event-key-123abc",
71         "metrics": [
72           {
73             "key": "metric-key-123abc",
74             "name": "Example metric",
75             "kind": "pageview",
76             "_links": {
77               "self": {
78                 "href": "/api/v2/metrics/my-project/my-metric",
79                 "type": "application/json"
80               }
81             },
82             "_versionId": "version-id-123abc",
83             "isNumeric": true,
84             "eventKey": "event-key-123abc",
85             "nameInGroup": "Step 1"
86           }
87         ]
88       },
89       "primarySingleMetric": {
90         "key": "metric-key-123abc",
91         "name": "Example metric",
92         "kind": "pageview",
93         "_links": {
94           "self": {
95             "href": "/api/v2/metrics/my-project/my-metric",
96             "type": "application/json"
97           }
98         },
99         "_versionId": "version-id-123abc",
100         "isNumeric": true,
101         "eventKey": "event-key-123abc"
102       },
103       "primaryFunnel": {
104         "key": "metric-group-key-123abc",
105         "name": "My metric group",
106         "kind": "funnel",
107         "_links": {
108           "parent": {
109             "href": "/api/v2/projects/my-project",
110             "type": "application/json"
111           },
112           "self": {
113             "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
114             "type": "application/json"
115           }
116         },
117         "metrics": [
118           {
119             "key": "metric-key-123abc",
120             "name": "Example metric",
121             "kind": "pageview",
122             "_links": {
123               "self": {
124                 "href": "/api/v2/metrics/my-project/my-metric",
125                 "type": "application/json"
126               }
127             },
128             "_versionId": "version-id-123abc",
129             "isNumeric": true,
130             "eventKey": "event-key-123abc",
131             "nameInGroup": "Step 1"
132           }
133         ]
134       },
135       "randomizationUnit": "user",
136       "attributes": [
137         "attributes"
138       ],
139       "treatments": [
140         {
141           "name": "Treatment 1",
142           "allocationPercent": "10",
143           "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
144           "baseline": true
145         }
146       ],
147       "metrics": [
148         {
149           "key": "metric-key-123abc",
150           "_versionId": "_versionId",
151           "name": "My metric",
152           "kind": "pageview",
153           "_links": {
154             "self": {
155               "href": "/api/v2/metrics/my-project/my-metric",
156               "type": "application/json"
157             }
158           },
159           "isGroup": true,
160           "isNumeric": true,
161           "eventKey": "event-key-123abc",
162           "metrics": [
163             {
164               "key": "metric-key-123abc",
165               "name": "Example metric",
166               "kind": "pageview",
167               "_links": {
168                 "self": {
169                   "href": "/api/v2/metrics/my-project/my-metric",
170                   "type": "application/json"
171                 }
172               },
173               "_versionId": "version-id-123abc",
174               "isNumeric": true,
175               "eventKey": "event-key-123abc",
176               "nameInGroup": "Step 1"
177             }
178           ]
179         }
180       ],
181       "layerSnapshot": {
182         "key": "checkout-flow",
183         "name": "Checkout Flow",
184         "reservationPercent": 10,
185         "otherReservationPercent": 70
186       },
187       "covarianceInfo": {
188         "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
189         "fileName": "covariance.csv",
190         "createdAt": 1000000
191       },
192       "secondaryMetrics": [
193         {
194           "key": "metric-key-123abc",
195           "name": "Example metric",
196           "kind": "pageview",
197           "_links": {
198             "self": {
199               "href": "/api/v2/metrics/my-project/my-metric",
200               "type": "application/json"
201             }
202           },
203           "_versionId": "version-id-123abc",
204           "isNumeric": true,
205           "eventKey": "event-key-123abc"
206         }
207       ]
208     },
209     "draftIteration": {
210       "hypothesis": "The new button placement will increase conversion",
211       "status": "running",
212       "createdAt": 1000000,
213       "_id": "12ab3c45de678910fgh12345",
214       "startedAt": 1000000,
215       "endedAt": 1000000,
216       "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
217       "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
218       "canReshuffleTraffic": true,
219       "flags": {
220         "key": {
221           "_links": {
222             "self": {
223               "href": "/api/v2/flags/my-project/my-flag",
224               "type": "application/json"
225             }
226           },
227           "targetingRule": "fallthrough",
228           "targetingRuleDescription": "Customers who live in Canada",
229           "flagConfigVersion": 12,
230           "notInExperimentVariationId": "e432f62b-55f6-49dd-a02f-eb24acf39d05"
231         }
232       },
233       "reallocationFrequencyMillis": 3600000,
234       "version": 0,
235       "primaryMetric": {
236         "key": "metric-key-123abc",
237         "_versionId": "_versionId",
238         "name": "My metric",
239         "kind": "pageview",
240         "_links": {
241           "self": {
242             "href": "/api/v2/metrics/my-project/my-metric",
243             "type": "application/json"
244           }
245         },
246         "isGroup": true,
247         "isNumeric": true,
248         "eventKey": "event-key-123abc",
249         "metrics": [
250           {
251             "key": "metric-key-123abc",
252             "name": "Example metric",
253             "kind": "pageview",
254             "_links": {
255               "self": {
256                 "href": "/api/v2/metrics/my-project/my-metric",
257                 "type": "application/json"
258               }
259             },
260             "_versionId": "version-id-123abc",
261             "isNumeric": true,
262             "eventKey": "event-key-123abc",
263             "nameInGroup": "Step 1"
264           }
265         ]
266       },
267       "primarySingleMetric": {
268         "key": "metric-key-123abc",
269         "name": "Example metric",
270         "kind": "pageview",
271         "_links": {
272           "self": {
273             "href": "/api/v2/metrics/my-project/my-metric",
274             "type": "application/json"
275           }
276         },
277         "_versionId": "version-id-123abc",
278         "isNumeric": true,
279         "eventKey": "event-key-123abc"
280       },
281       "primaryFunnel": {
282         "key": "metric-group-key-123abc",
283         "name": "My metric group",
284         "kind": "funnel",
285         "_links": {
286           "parent": {
287             "href": "/api/v2/projects/my-project",
288             "type": "application/json"
289           },
290           "self": {
291             "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
292             "type": "application/json"
293           }
294         },
295         "metrics": [
296           {
297             "key": "metric-key-123abc",
298             "name": "Example metric",
299             "kind": "pageview",
300             "_links": {
301               "self": {
302                 "href": "/api/v2/metrics/my-project/my-metric",
303                 "type": "application/json"
304               }
305             },
306             "_versionId": "version-id-123abc",
307             "isNumeric": true,
308             "eventKey": "event-key-123abc",
309             "nameInGroup": "Step 1"
310           }
311         ]
312       },
313       "randomizationUnit": "user",
314       "attributes": [
315         "attributes"
316       ],
317       "treatments": [
318         {
319           "name": "Treatment 1",
320           "allocationPercent": "10",
321           "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
322           "baseline": true
323         }
324       ],
325       "metrics": [
326         {
327           "key": "metric-key-123abc",
328           "_versionId": "_versionId",
329           "name": "My metric",
330           "kind": "pageview",
331           "_links": {
332             "self": {
333               "href": "/api/v2/metrics/my-project/my-metric",
334               "type": "application/json"
335             }
336           },
337           "isGroup": true,
338           "isNumeric": true,
339           "eventKey": "event-key-123abc",
340           "metrics": [
341             {
342               "key": "metric-key-123abc",
343               "name": "Example metric",
344               "kind": "pageview",
345               "_links": {
346                 "self": {
347                   "href": "/api/v2/metrics/my-project/my-metric",
348                   "type": "application/json"
349                 }
350               },
351               "_versionId": "version-id-123abc",
352               "isNumeric": true,
353               "eventKey": "event-key-123abc",
354               "nameInGroup": "Step 1"
355             }
356           ]
357         }
358       ],
359       "layerSnapshot": {
360         "key": "checkout-flow",
361         "name": "Checkout Flow",
362         "reservationPercent": 10,
363         "otherReservationPercent": 70
364       },
365       "covarianceInfo": {
366         "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
367         "fileName": "covariance.csv",
368         "createdAt": 1000000
369       },
370       "secondaryMetrics": [
371         {
372           "key": "metric-key-123abc",
373           "name": "Example metric",
374           "kind": "pageview",
375           "_links": {
376             "self": {
377               "href": "/api/v2/metrics/my-project/my-metric",
378               "type": "application/json"
379             }
380           },
381           "_versionId": "version-id-123abc",
382           "isNumeric": true,
383           "eventKey": "event-key-123abc"
384         }
385       ]
386     },
387     "previousIterations": [
388       {
389         "hypothesis": "The new button placement will increase conversion",
390         "status": "running",
391         "createdAt": 1000000,
392         "_id": "12ab3c45de678910fgh12345",
393         "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
394         "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
395         "canReshuffleTraffic": true,
396         "reallocationFrequencyMillis": 3600000,
397         "version": 0,
398         "primaryMetric": {
399           "key": "metric-key-123abc",
400           "_versionId": "_versionId",
401           "name": "My metric",
402           "kind": "pageview",
403           "_links": {
404             "self": {
405               "href": "/api/v2/metrics/my-project/my-metric",
406               "type": "application/json"
407             }
408           },
409           "isGroup": true,
410           "isNumeric": true,
411           "eventKey": "event-key-123abc",
412           "metrics": [
413             {
414               "key": "metric-key-123abc",
415               "name": "Example metric",
416               "kind": "pageview",
417               "_links": {
418                 "self": {
419                   "href": "/api/v2/metrics/my-project/my-metric",
420                   "type": "application/json"
421                 }
422               },
423               "_versionId": "version-id-123abc",
424               "isNumeric": true,
425               "eventKey": "event-key-123abc",
426               "nameInGroup": "Step 1"
427             }
428           ]
429         },
430         "primarySingleMetric": {
431           "key": "metric-key-123abc",
432           "name": "Example metric",
433           "kind": "pageview",
434           "_links": {
435             "self": {
436               "href": "/api/v2/metrics/my-project/my-metric",
437               "type": "application/json"
438             }
439           },
440           "_versionId": "version-id-123abc",
441           "isNumeric": true,
442           "eventKey": "event-key-123abc"
443         },
444         "primaryFunnel": {
445           "key": "metric-group-key-123abc",
446           "name": "My metric group",
447           "kind": "funnel",
448           "_links": {
449             "parent": {
450               "href": "/api/v2/projects/my-project",
451               "type": "application/json"
452             },
453             "self": {
454               "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
455               "type": "application/json"
456             }
457           },
458           "metrics": [
459             {
460               "key": "metric-key-123abc",
461               "name": "Example metric",
462               "kind": "pageview",
463               "_links": {
464                 "self": {
465                   "href": "/api/v2/metrics/my-project/my-metric",
466                   "type": "application/json"
467                 }
468               },
469               "_versionId": "version-id-123abc",
470               "isNumeric": true,
471               "eventKey": "event-key-123abc",
472               "nameInGroup": "Step 1"
473             }
474           ]
475         },
476         "randomizationUnit": "user",
477         "treatments": [
478           {
479             "name": "Treatment 1",
480             "allocationPercent": "10",
481             "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
482             "baseline": true
483           }
484         ],
485         "metrics": [
486           {
487             "key": "metric-key-123abc",
488             "_versionId": "_versionId",
489             "name": "My metric",
490             "kind": "pageview",
491             "_links": {
492               "self": {
493                 "href": "/api/v2/metrics/my-project/my-metric",
494                 "type": "application/json"
495               }
496             },
497             "isGroup": true,
498             "isNumeric": true,
499             "eventKey": "event-key-123abc",
500             "metrics": [
501               {
502                 "key": "metric-key-123abc",
503                 "name": "Example metric",
504                 "kind": "pageview",
505                 "_links": {
506                   "self": {
507                     "href": "/api/v2/metrics/my-project/my-metric",
508                     "type": "application/json"
509                   }
510                 },
511                 "_versionId": "version-id-123abc",
512                 "isNumeric": true,
513                 "eventKey": "event-key-123abc",
514                 "nameInGroup": "Step 1"
515               }
516             ]
517           }
518         ],
519         "layerSnapshot": {
520           "key": "checkout-flow",
521           "name": "Checkout Flow",
522           "reservationPercent": 10,
523           "otherReservationPercent": 70
524         },
525         "covarianceInfo": {
526           "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
527           "fileName": "covariance.csv",
528           "createdAt": 1000000
529         },
530         "secondaryMetrics": [
531           {
532             "key": "metric-key-123abc",
533             "name": "Example metric",
534             "kind": "pageview",
535             "_links": {
536               "self": {
537                 "href": "/api/v2/metrics/my-project/my-metric",
538                 "type": "application/json"
539               }
540             },
541             "_versionId": "version-id-123abc",
542             "isNumeric": true,
543             "eventKey": "event-key-123abc"
544           }
545         ]
546       }
547     ]
548   },
549   "description": "description",
550   "isDirty": true,
551   "relatedExperiments": [
552     {
553       "key": "experiment-key-123abc",
554       "name": "Example experiment",
555       "_maintainerId": "12ab3c45de678910fgh12345",
556       "_creationDate": 1000000,
557       "environmentKey": "environmentKey",
558       "_links": {
559         "parent": {
560           "href": "/api/v2/projects/my-project/environments/my-environment",
561           "type": "application/json"
562         },
563         "self": {
564           "href": "/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment",
565           "type": "application/json"
566         }
567       },
568       "_id": "12ab3c45de678910fgh12345",
569       "description": "An example experiment, used in testing",
570       "archivedDate": 1000000,
571       "tags": [
572         "experiment",
573         "feature"
574       ],
575       "holdoutId": "f3b74309-d581-44e1-8a2b-bb2933b4fe40",
576       "currentIteration": {
577         "hypothesis": "The new button placement will increase conversion",
578         "status": "running",
579         "createdAt": 1000000,
580         "_id": "12ab3c45de678910fgh12345",
581         "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
582         "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
583         "canReshuffleTraffic": true,
584         "reallocationFrequencyMillis": 3600000,
585         "version": 0,
586         "primaryMetric": {
587           "key": "metric-key-123abc",
588           "_versionId": "_versionId",
589           "name": "My metric",
590           "kind": "pageview",
591           "_links": {
592             "self": {
593               "href": "/api/v2/metrics/my-project/my-metric",
594               "type": "application/json"
595             }
596           },
597           "isGroup": true,
598           "isNumeric": true,
599           "eventKey": "event-key-123abc",
600           "metrics": [
601             {
602               "key": "metric-key-123abc",
603               "name": "Example metric",
604               "kind": "pageview",
605               "_links": {
606                 "self": {
607                   "href": "/api/v2/metrics/my-project/my-metric",
608                   "type": "application/json"
609                 }
610               },
611               "_versionId": "version-id-123abc",
612               "isNumeric": true,
613               "eventKey": "event-key-123abc",
614               "nameInGroup": "Step 1"
615             }
616           ]
617         },
618         "primarySingleMetric": {
619           "key": "metric-key-123abc",
620           "name": "Example metric",
621           "kind": "pageview",
622           "_links": {
623             "self": {
624               "href": "/api/v2/metrics/my-project/my-metric",
625               "type": "application/json"
626             }
627           },
628           "_versionId": "version-id-123abc",
629           "isNumeric": true,
630           "eventKey": "event-key-123abc"
631         },
632         "primaryFunnel": {
633           "key": "metric-group-key-123abc",
634           "name": "My metric group",
635           "kind": "funnel",
636           "_links": {
637             "parent": {
638               "href": "/api/v2/projects/my-project",
639               "type": "application/json"
640             },
641             "self": {
642               "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
643               "type": "application/json"
644             }
645           },
646           "metrics": [
647             {
648               "key": "metric-key-123abc",
649               "name": "Example metric",
650               "kind": "pageview",
651               "_links": {
652                 "self": {
653                   "href": "/api/v2/metrics/my-project/my-metric",
654                   "type": "application/json"
655                 }
656               },
657               "_versionId": "version-id-123abc",
658               "isNumeric": true,
659               "eventKey": "event-key-123abc",
660               "nameInGroup": "Step 1"
661             }
662           ]
663         },
664         "randomizationUnit": "user",
665         "treatments": [
666           {
667             "name": "Treatment 1",
668             "allocationPercent": "10",
669             "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
670             "baseline": true
671           }
672         ],
673         "metrics": [
674           {
675             "key": "metric-key-123abc",
676             "_versionId": "_versionId",
677             "name": "My metric",
678             "kind": "pageview",
679             "_links": {
680               "self": {
681                 "href": "/api/v2/metrics/my-project/my-metric",
682                 "type": "application/json"
683               }
684             },
685             "isGroup": true,
686             "isNumeric": true,
687             "eventKey": "event-key-123abc",
688             "metrics": [
689               {
690                 "key": "metric-key-123abc",
691                 "name": "Example metric",
692                 "kind": "pageview",
693                 "_links": {
694                   "self": {
695                     "href": "/api/v2/metrics/my-project/my-metric",
696                     "type": "application/json"
697                   }
698                 },
699                 "_versionId": "version-id-123abc",
700                 "isNumeric": true,
701                 "eventKey": "event-key-123abc",
702                 "nameInGroup": "Step 1"
703               }
704             ]
705           }
706         ],
707         "layerSnapshot": {
708           "key": "checkout-flow",
709           "name": "Checkout Flow",
710           "reservationPercent": 10,
711           "otherReservationPercent": 70
712         },
713         "covarianceInfo": {
714           "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
715           "fileName": "covariance.csv",
716           "createdAt": 1000000
717         },
718         "secondaryMetrics": [
719           {
720             "key": "metric-key-123abc",
721             "name": "Example metric",
722             "kind": "pageview",
723             "_links": {
724               "self": {
725                 "href": "/api/v2/metrics/my-project/my-metric",
726                 "type": "application/json"
727               }
728             },
729             "_versionId": "version-id-123abc",
730             "isNumeric": true,
731             "eventKey": "event-key-123abc"
732           }
733         ]
734       },
735       "draftIteration": {
736         "hypothesis": "The new button placement will increase conversion",
737         "status": "running",
738         "createdAt": 1000000,
739         "_id": "12ab3c45de678910fgh12345",
740         "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
741         "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
742         "canReshuffleTraffic": true,
743         "reallocationFrequencyMillis": 3600000,
744         "version": 0,
745         "primaryMetric": {
746           "key": "metric-key-123abc",
747           "_versionId": "_versionId",
748           "name": "My metric",
749           "kind": "pageview",
750           "_links": {
751             "self": {
752               "href": "/api/v2/metrics/my-project/my-metric",
753               "type": "application/json"
754             }
755           },
756           "isGroup": true,
757           "isNumeric": true,
758           "eventKey": "event-key-123abc",
759           "metrics": [
760             {
761               "key": "metric-key-123abc",
762               "name": "Example metric",
763               "kind": "pageview",
764               "_links": {
765                 "self": {
766                   "href": "/api/v2/metrics/my-project/my-metric",
767                   "type": "application/json"
768                 }
769               },
770               "_versionId": "version-id-123abc",
771               "isNumeric": true,
772               "eventKey": "event-key-123abc",
773               "nameInGroup": "Step 1"
774             }
775           ]
776         },
777         "primarySingleMetric": {
778           "key": "metric-key-123abc",
779           "name": "Example metric",
780           "kind": "pageview",
781           "_links": {
782             "self": {
783               "href": "/api/v2/metrics/my-project/my-metric",
784               "type": "application/json"
785             }
786           },
787           "_versionId": "version-id-123abc",
788           "isNumeric": true,
789           "eventKey": "event-key-123abc"
790         },
791         "primaryFunnel": {
792           "key": "metric-group-key-123abc",
793           "name": "My metric group",
794           "kind": "funnel",
795           "_links": {
796             "parent": {
797               "href": "/api/v2/projects/my-project",
798               "type": "application/json"
799             },
800             "self": {
801               "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
802               "type": "application/json"
803             }
804           },
805           "metrics": [
806             {
807               "key": "metric-key-123abc",
808               "name": "Example metric",
809               "kind": "pageview",
810               "_links": {
811                 "self": {
812                   "href": "/api/v2/metrics/my-project/my-metric",
813                   "type": "application/json"
814                 }
815               },
816               "_versionId": "version-id-123abc",
817               "isNumeric": true,
818               "eventKey": "event-key-123abc",
819               "nameInGroup": "Step 1"
820             }
821           ]
822         },
823         "randomizationUnit": "user",
824         "treatments": [
825           {
826             "name": "Treatment 1",
827             "allocationPercent": "10",
828             "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
829             "baseline": true
830           }
831         ],
832         "metrics": [
833           {
834             "key": "metric-key-123abc",
835             "_versionId": "_versionId",
836             "name": "My metric",
837             "kind": "pageview",
838             "_links": {
839               "self": {
840                 "href": "/api/v2/metrics/my-project/my-metric",
841                 "type": "application/json"
842               }
843             },
844             "isGroup": true,
845             "isNumeric": true,
846             "eventKey": "event-key-123abc",
847             "metrics": [
848               {
849                 "key": "metric-key-123abc",
850                 "name": "Example metric",
851                 "kind": "pageview",
852                 "_links": {
853                   "self": {
854                     "href": "/api/v2/metrics/my-project/my-metric",
855                     "type": "application/json"
856                   }
857                 },
858                 "_versionId": "version-id-123abc",
859                 "isNumeric": true,
860                 "eventKey": "event-key-123abc",
861                 "nameInGroup": "Step 1"
862               }
863             ]
864           }
865         ],
866         "layerSnapshot": {
867           "key": "checkout-flow",
868           "name": "Checkout Flow",
869           "reservationPercent": 10,
870           "otherReservationPercent": 70
871         },
872         "covarianceInfo": {
873           "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
874           "fileName": "covariance.csv",
875           "createdAt": 1000000
876         },
877         "secondaryMetrics": [
878           {
879             "key": "metric-key-123abc",
880             "name": "Example metric",
881             "kind": "pageview",
882             "_links": {
883               "self": {
884                 "href": "/api/v2/metrics/my-project/my-metric",
885                 "type": "application/json"
886               }
887             },
888             "_versionId": "version-id-123abc",
889             "isNumeric": true,
890             "eventKey": "event-key-123abc"
891           }
892         ]
893       },
894       "previousIterations": [
895         {
896           "hypothesis": "The new button placement will increase conversion",
897           "status": "running",
898           "createdAt": 1000000,
899           "_id": "12ab3c45de678910fgh12345",
900           "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
901           "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
902           "canReshuffleTraffic": true,
903           "reallocationFrequencyMillis": 3600000,
904           "version": 0,
905           "primaryMetric": {
906             "key": "metric-key-123abc",
907             "_versionId": "_versionId",
908             "name": "My metric",
909             "kind": "pageview",
910             "_links": {
911               "self": {
912                 "href": "/api/v2/metrics/my-project/my-metric",
913                 "type": "application/json"
914               }
915             },
916             "isGroup": true,
917             "isNumeric": true,
918             "eventKey": "event-key-123abc",
919             "metrics": [
920               {
921                 "key": "metric-key-123abc",
922                 "name": "Example metric",
923                 "kind": "pageview",
924                 "_links": {
925                   "self": {
926                     "href": "/api/v2/metrics/my-project/my-metric",
927                     "type": "application/json"
928                   }
929                 },
930                 "_versionId": "version-id-123abc",
931                 "isNumeric": true,
932                 "eventKey": "event-key-123abc",
933                 "nameInGroup": "Step 1"
934               }
935             ]
936           },
937           "primarySingleMetric": {
938             "key": "metric-key-123abc",
939             "name": "Example metric",
940             "kind": "pageview",
941             "_links": {
942               "self": {
943                 "href": "/api/v2/metrics/my-project/my-metric",
944                 "type": "application/json"
945               }
946             },
947             "_versionId": "version-id-123abc",
948             "isNumeric": true,
949             "eventKey": "event-key-123abc"
950           },
951           "primaryFunnel": {
952             "key": "metric-group-key-123abc",
953             "name": "My metric group",
954             "kind": "funnel",
955             "_links": {
956               "parent": {
957                 "href": "/api/v2/projects/my-project",
958                 "type": "application/json"
959               },
960               "self": {
961                 "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
962                 "type": "application/json"
963               }
964             },
965             "metrics": [
966               {
967                 "key": "metric-key-123abc",
968                 "name": "Example metric",
969                 "kind": "pageview",
970                 "_links": {
971                   "self": {
972                     "href": "/api/v2/metrics/my-project/my-metric",
973                     "type": "application/json"
974                   }
975                 },
976                 "_versionId": "version-id-123abc",
977                 "isNumeric": true,
978                 "eventKey": "event-key-123abc",
979                 "nameInGroup": "Step 1"
980               }
981             ]
982           },
983           "randomizationUnit": "user",
984           "treatments": [
985             {
986               "name": "Treatment 1",
987               "allocationPercent": "10",
988               "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
989               "baseline": true
990             }
991           ],
992           "metrics": [
993             {
994               "key": "metric-key-123abc",
995               "_versionId": "_versionId",
996               "name": "My metric",
997               "kind": "pageview",
998               "_links": {
999                 "self": {
1000                   "href": "/api/v2/metrics/my-project/my-metric",
1001                   "type": "application/json"
1002                 }
1003               },
1004               "isGroup": true,
1005               "isNumeric": true,
1006               "eventKey": "event-key-123abc",
1007               "metrics": [
1008                 {
1009                   "key": "metric-key-123abc",
1010                   "name": "Example metric",
1011                   "kind": "pageview",
1012                   "_links": {
1013                     "self": {
1014                       "href": "/api/v2/metrics/my-project/my-metric",
1015                       "type": "application/json"
1016                     }
1017                   },
1018                   "_versionId": "version-id-123abc",
1019                   "isNumeric": true,
1020                   "eventKey": "event-key-123abc",
1021                   "nameInGroup": "Step 1"
1022                 }
1023               ]
1024             }
1025           ],
1026           "layerSnapshot": {
1027             "key": "checkout-flow",
1028             "name": "Checkout Flow",
1029             "reservationPercent": 10,
1030             "otherReservationPercent": 70
1031           },
1032           "covarianceInfo": {
1033             "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
1034             "fileName": "covariance.csv",
1035             "createdAt": 1000000
1036           },
1037           "secondaryMetrics": [
1038             {
1039               "key": "metric-key-123abc",
1040               "name": "Example metric",
1041               "kind": "pageview",
1042               "_links": {
1043                 "self": {
1044                   "href": "/api/v2/metrics/my-project/my-metric",
1045                   "type": "application/json"
1046                 }
1047               },
1048               "_versionId": "version-id-123abc",
1049               "isNumeric": true,
1050               "eventKey": "event-key-123abc"
1051             }
1052           ]
1053         }
1054       ]
1055     }
1056   ]
1057 }

Get details about a holdout.

Expanding the holdout response

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.

Get details about a holdout. ### Expanding the holdout response 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.

Authentication

Authorizationstring

API Key authentication via header

Path Parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

holdoutKeystringRequired

The holdout experiment key

Query Parameters

expandstringOptional

A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above. Holdout experiment expansion fields have no prefix. Related experiment expansion fields have rel- as a prefix.

Response

HoldoutDetail response with full experiments

_idstring

statusenum

Allowed values:

holdoutAmountstring

The percentage of traffic allocated to this holdout.

createdAtlong

updatedAtlong

baseExperimentobject

descriptionstring or null

isDirtyboolean or null

Indicates if the holdout experiment is running and if any related experiments are running.

relatedExperimentslist of objects or null

Expanding the holdout response

Authentication

Path Parameters

Query Parameters

Response

Errors

Expanding the holdout response