Get experiments any environment

GET

/api/v2/projects/:projectKey/experiments

GET

/api/v2/projects/:projectKey/experiments

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

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

Get a list of experiments from across all environments in the project

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequiredformat: "string"

The project 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.

filterstringOptionalformat: "string"

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

expandstringOptionalformat: "string"

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

lifecycleStatestringOptionalformat: "string"

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

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

_linksmap from strings to objects

The location and content type of related resources

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