Create experiment

POST

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

POST

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

1 import requests
2 
3 url = "https://app.launchdarkly.com/api/v2/projects/projectKey/environments/environmentKey/experiments"
4 
5 payload = {
6     "name": "Example experiment",
7     "key": "experiment-key-123abc"
8 }
9 headers = {
10     "Authorization": "<apiKey>",
11     "Content-Type": "application/json"
12 }
13 
14 response = requests.post(url, json=payload, headers=headers)
15 
16 print(response.json())

Try it

201Created

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

Create an experiment.

To run this experiment, you’ll need to create an iteration and then update the experiment with the startIteration instruction.

To learn more, read Creating experiments.

Path parameters

projectKeystringRequired

The project key

environmentKeystringRequired

The environment key

Request

This endpoint expects an object.

namestringRequired

The experiment name

keystringRequired

The experiment key

iterationobjectRequired

Details on the construction of the initial iteration

descriptionstringOptional

The experiment description

maintainerIdstringOptional

The ID of the member who maintains this experiment

holdoutIdstringOptional

The ID of the holdout

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.

Create experiment

Path parameters

Headers

Request

Response

Errors