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>"

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

Get details about an experiment.

Expanding the experiment response

LaunchDarkly supports five 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.
analysisConfig includes the analysis configuration for the experiment, such as the Bayesian threshold or significance threshold.

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 five 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. - `analysisConfig` includes the analysis configuration for the experiment, such as the Bayesian threshold or significance threshold. 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

projectKeystringRequiredformat: "string"

The project key

environmentKeystringRequiredformat: "string"

The environment key

experimentKeystringRequiredformat: "string"

The experiment key

Query parameters

expandstringOptionalformat: "string"

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

The experiment ID

descriptionstring

The experiment description

methodologyenum

The results analysis approach.

Allowed values:

dataSourceenum

The source of metric data in order to analyze results. Defaults to "launchdarkly" when not provided.

Allowed values:

archivedDatelong

Timestamp of when the experiment was archived

tagslist of strings

Tags for the experiment

holdoutIdstring

The holdout ID

currentIterationobject

Details on the current iteration

typestring

The experiment type

draftIterationobject

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

previousIterationslist of objects

Details on the previous iterations for this experiment.

analysisConfigobject

Details of the Analysis Configuration for this experiment.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

429

Too Many Requests Error