Get experiment

GET

/api/v2/projects/:projectKey/environments/:environmentKey/experiments/:experimentKey

GET

/api/v2/projects/:projectKey/environments/:environmentKey/experiments/:experimentKey

1 curl https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/experiments/experimentKey \
2      -H "Authorization: <apiKey>"

Try it

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

Get details about an experiment.

Expanding the experiment response

LaunchDarkly supports four fields for expanding the “Get experiment” 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:

previousIterations includes all iterations prior to the current iteration. By default only the current iteration is included in the response.
draftIteration includes the iteration which has not been started yet, if any.
secondaryMetrics includes secondary metrics. By default only the primary metric is included in the response.
treatments includes all treatment and parameter details. By default treatment data is not included in the response.

For example, expand=draftIteration,treatments includes the draftIteration and treatments 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 an experiment. ### Expanding the experiment response LaunchDarkly supports four fields for expanding the "Get experiment" 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: - `previousIterations` includes all iterations prior to the current iteration. By default only the current iteration is included in the response. - `draftIteration` includes the iteration which has not been started yet, if any. - `secondaryMetrics` includes secondary metrics. By default only the primary metric is included in the response. - `treatments` includes all treatment and parameter details. By default treatment data is not included in the response. For example, `expand=draftIteration,treatments` includes the `draftIteration` and `treatments` 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

experimentKeystringRequired

The experiment key

Query parameters

expandstringOptional

A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.

Response

Experiment response

keystring

The experiment key

namestring

The experiment name

_maintainerIdstring

The ID of the member who maintains this experiment.

_creationDatelong

Timestamp of when the experiment was created

environmentKeystring

_linksmap from strings to objects

The location and content type of related resources

_idstring or null

The experiment ID

descriptionstring or null

The experiment description

archivedDatelong or null

Timestamp of when the experiment was archived

holdoutIdstring or null

The holdout ID

currentIterationobject or null

Details on the current iteration

draftIterationobject or null

Details on the current iteration. This iteration may be already started, or may still be a draft.

previousIterationslist of objects or null

Details on the previous iterations for this experiment.

Expanding the experiment response

Authentication

Path parameters

Query parameters

Response

Errors

Expanding the experiment response