Get experiments

GET

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

GET

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

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

Try it

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

Get details about all experiments in an environment.

Filtering experiments

LaunchDarkly supports the filter query param for filtering, with the following fields:

flagKey filters for only experiments that use the flag with the given key.
metricKey filters for only experiments that use the metric with the given key.
status filters for only experiments with an iteration with the given status. An iteration can have the status not_started, running or stopped.

For example, filter=flagKey:my-flag,status:running,metricKey:page-load-ms filters for experiments for the given flag key and the given metric key which have a currently running iteration.

Expanding the experiments response

LaunchDarkly supports four fields for expanding the “Get experiments” 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 all experiments in an environment. ### Filtering experiments LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `flagKey` filters for only experiments that use the flag with the given key. - `metricKey` filters for only experiments that use the metric with the given key. - `status` filters for only experiments with an iteration with the given status. An iteration can have the status `not_started`, `running` or `stopped`. For example, `filter=flagKey:my-flag,status:running,metricKey:page-load-ms` filters for experiments for the given flag key and the given metric key which have a currently running iteration. ### Expanding the experiments response LaunchDarkly supports four fields for expanding the "Get experiments" 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

Query Parameters

limitlongOptional

The maximum number of experiments to return. Defaults to 20.

offsetlongOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

filterstringOptional

A comma-separated list of filters. Each filter is of the form field:value. Supported fields are explained above.

expandstringOptional

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

lifecycleStatestringOptional

A comma-separated list of experiment archived states. Supports archived, active, or both. Defaults to active experiments.

Response

Experiment collection response

itemslist of objects

An array of experiments

total_countinteger or null

The total number of experiments in this project and environment. Does not include legacy experiments.

_linksmap from strings to objects or null

The location and content type of related resources

Filtering experiments

Expanding the experiments response

Authentication

Path Parameters

Query Parameters

Response

Errors

Filtering experiments

Expanding the experiments response