Get experiments

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

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 five 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.
• 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 /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments

Get experiments

cURL

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments \
  --header 'Authorization: <api-key>'

200

{
  "items": [
    {
      "key": "experiment-key-123abc",
      "name": "Example experiment",
      "_maintainerId": "12ab3c45de678910fgh12345",
      "_creationDate": "1654104600000",
      "environmentKey": "<string>",
      "_links": {
        "parent": {
          "href": "/api/v2/projects/my-project/environments/my-environment",
          "type": "application/json"
        },
        "self": {
          "href": "/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment",
          "type": "application/json"
        }
      },
      "_id": "12ab3c45de678910fgh12345",
      "description": "An example experiment, used in testing",
      "methodology": "bayesian",
      "dataSource": "snowflake",
      "archivedDate": "1654104600000",
      "tags": [
        "experiment",
        "feature"
      ],
      "holdoutId": "f3b74309-d581-44e1-8a2b-bb2933b4fe40",
      "currentIteration": {
        "hypothesis": "The new button placement will increase conversion",
        "status": "running",
        "createdAt": "1654104600000",
        "_id": "12ab3c45de678910fgh12345",
        "startedAt": "1655314200000",
        "endedAt": "1656610200000",
        "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
        "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
        "canReshuffleTraffic": true,
        "flags": {},
        "reallocationFrequencyMillis": 3600000,
        "version": 0,
        "primaryMetric": {
          "key": "metric-key-123abc",
          "_versionId": "<string>",
          "name": "My metric",
          "kind": "custom",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "isGroup": true,
          "isNumeric": true,
          "eventKey": "event-key-123abc",
          "metrics": [
            {
              "key": "metric-key-123abc",
              "name": "Example metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "_versionId": "version-id-123abc",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "primarySingleMetric": {
          "key": "metric-key-123abc",
          "name": "Example metric",
          "kind": "custom",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "_versionId": "version-id-123abc",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc"
        },
        "primaryFunnel": {
          "key": "metric-group-key-123abc",
          "name": "My metric group",
          "kind": "funnel",
          "_links": {
            "parent": {
              "href": "/api/v2/projects/my-project",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "name": "Example metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "_versionId": "version-id-123abc",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "randomizationUnit": "user",
        "attributes": [
          "<string>"
        ],
        "treatments": [
          {
            "name": "Treatment 1",
            "allocationPercent": "10",
            "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
            "baseline": true,
            "parameters": [
              {
                "variationId": "<string>",
                "flagKey": "<string>"
              }
            ]
          }
        ],
        "secondaryMetrics": [
          {
            "key": "metric-key-123abc",
            "name": "Example metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "_versionId": "version-id-123abc",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc"
          }
        ],
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "<string>",
            "name": "My metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "isGroup": true,
            "isNumeric": true,
            "eventKey": "event-key-123abc",
            "metrics": [
              {
                "key": "metric-key-123abc",
                "name": "Example metric",
                "kind": "custom",
                "_links": {
                  "self": {
                    "href": "/api/v2/metrics/my-project/my-metric",
                    "type": "application/json"
                  }
                },
                "_versionId": "version-id-123abc",
                "isNumeric": true,
                "unitAggregationType": "sum",
                "eventKey": "event-key-123abc",
                "nameInGroup": "Step 1",
                "randomizationUnits": [
                  "user"
                ]
              }
            ]
          }
        ],
        "layerSnapshot": {
          "key": "checkout-flow",
          "name": "Checkout Flow",
          "reservationPercent": 10,
          "otherReservationPercent": 70
        },
        "covariateInfo": {
          "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
          "fileName": "covariate.csv",
          "createdAt": "1654104600000"
        }
      },
      "type": "experiment",
      "draftIteration": {
        "hypothesis": "The new button placement will increase conversion",
        "status": "running",
        "createdAt": "1654104600000",
        "_id": "12ab3c45de678910fgh12345",
        "startedAt": "1655314200000",
        "endedAt": "1656610200000",
        "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
        "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
        "canReshuffleTraffic": true,
        "flags": {},
        "reallocationFrequencyMillis": 3600000,
        "version": 0,
        "primaryMetric": {
          "key": "metric-key-123abc",
          "_versionId": "<string>",
          "name": "My metric",
          "kind": "custom",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "isGroup": true,
          "isNumeric": true,
          "eventKey": "event-key-123abc",
          "metrics": [
            {
              "key": "metric-key-123abc",
              "name": "Example metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "_versionId": "version-id-123abc",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "primarySingleMetric": {
          "key": "metric-key-123abc",
          "name": "Example metric",
          "kind": "custom",
          "_links": {
            "self": {
              "href": "/api/v2/metrics/my-project/my-metric",
              "type": "application/json"
            }
          },
          "_versionId": "version-id-123abc",
          "isNumeric": true,
          "unitAggregationType": "sum",
          "eventKey": "event-key-123abc"
        },
        "primaryFunnel": {
          "key": "metric-group-key-123abc",
          "name": "My metric group",
          "kind": "funnel",
          "_links": {
            "parent": {
              "href": "/api/v2/projects/my-project",
              "type": "application/json"
            },
            "self": {
              "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
              "type": "application/json"
            }
          },
          "metrics": [
            {
              "key": "metric-key-123abc",
              "name": "Example metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "_versionId": "version-id-123abc",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc",
              "nameInGroup": "Step 1",
              "randomizationUnits": [
                "user"
              ]
            }
          ]
        },
        "randomizationUnit": "user",
        "attributes": [
          "<string>"
        ],
        "treatments": [
          {
            "name": "Treatment 1",
            "allocationPercent": "10",
            "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
            "baseline": true,
            "parameters": [
              {
                "variationId": "<string>",
                "flagKey": "<string>"
              }
            ]
          }
        ],
        "secondaryMetrics": [
          {
            "key": "metric-key-123abc",
            "name": "Example metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "_versionId": "version-id-123abc",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc"
          }
        ],
        "metrics": [
          {
            "key": "metric-key-123abc",
            "_versionId": "<string>",
            "name": "My metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "isGroup": true,
            "isNumeric": true,
            "eventKey": "event-key-123abc",
            "metrics": [
              {
                "key": "metric-key-123abc",
                "name": "Example metric",
                "kind": "custom",
                "_links": {
                  "self": {
                    "href": "/api/v2/metrics/my-project/my-metric",
                    "type": "application/json"
                  }
                },
                "_versionId": "version-id-123abc",
                "isNumeric": true,
                "unitAggregationType": "sum",
                "eventKey": "event-key-123abc",
                "nameInGroup": "Step 1",
                "randomizationUnits": [
                  "user"
                ]
              }
            ]
          }
        ],
        "layerSnapshot": {
          "key": "checkout-flow",
          "name": "Checkout Flow",
          "reservationPercent": 10,
          "otherReservationPercent": 70
        },
        "covariateInfo": {
          "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
          "fileName": "covariate.csv",
          "createdAt": "1654104600000"
        }
      },
      "previousIterations": [
        {
          "hypothesis": "The new button placement will increase conversion",
          "status": "running",
          "createdAt": "1654104600000",
          "_id": "12ab3c45de678910fgh12345",
          "startedAt": "1655314200000",
          "endedAt": "1656610200000",
          "winningTreatmentId": "122c9f3e-da26-4321-ba68-e0fc02eced58",
          "winningReason": "We ran this iteration for two weeks and the winning variation was clear",
          "canReshuffleTraffic": true,
          "flags": {},
          "reallocationFrequencyMillis": 3600000,
          "version": 0,
          "primaryMetric": {
            "key": "metric-key-123abc",
            "_versionId": "<string>",
            "name": "My metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "isGroup": true,
            "isNumeric": true,
            "eventKey": "event-key-123abc",
            "metrics": [
              {
                "key": "metric-key-123abc",
                "name": "Example metric",
                "kind": "custom",
                "_links": {
                  "self": {
                    "href": "/api/v2/metrics/my-project/my-metric",
                    "type": "application/json"
                  }
                },
                "_versionId": "version-id-123abc",
                "isNumeric": true,
                "unitAggregationType": "sum",
                "eventKey": "event-key-123abc",
                "nameInGroup": "Step 1",
                "randomizationUnits": [
                  "user"
                ]
              }
            ]
          },
          "primarySingleMetric": {
            "key": "metric-key-123abc",
            "name": "Example metric",
            "kind": "custom",
            "_links": {
              "self": {
                "href": "/api/v2/metrics/my-project/my-metric",
                "type": "application/json"
              }
            },
            "_versionId": "version-id-123abc",
            "isNumeric": true,
            "unitAggregationType": "sum",
            "eventKey": "event-key-123abc"
          },
          "primaryFunnel": {
            "key": "metric-group-key-123abc",
            "name": "My metric group",
            "kind": "funnel",
            "_links": {
              "parent": {
                "href": "/api/v2/projects/my-project",
                "type": "application/json"
              },
              "self": {
                "href": "/api/v2/projects/my-project/metric-groups/my-metric-group",
                "type": "application/json"
              }
            },
            "metrics": [
              {
                "key": "metric-key-123abc",
                "name": "Example metric",
                "kind": "custom",
                "_links": {
                  "self": {
                    "href": "/api/v2/metrics/my-project/my-metric",
                    "type": "application/json"
                  }
                },
                "_versionId": "version-id-123abc",
                "isNumeric": true,
                "unitAggregationType": "sum",
                "eventKey": "event-key-123abc",
                "nameInGroup": "Step 1",
                "randomizationUnits": [
                  "user"
                ]
              }
            ]
          },
          "randomizationUnit": "user",
          "attributes": [
            "<string>"
          ],
          "treatments": [
            {
              "name": "Treatment 1",
              "allocationPercent": "10",
              "_id": "122c9f3e-da26-4321-ba68-e0fc02eced58",
              "baseline": true,
              "parameters": [
                {
                  "variationId": "<string>",
                  "flagKey": "<string>"
                }
              ]
            }
          ],
          "secondaryMetrics": [
            {
              "key": "metric-key-123abc",
              "name": "Example metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "_versionId": "version-id-123abc",
              "isNumeric": true,
              "unitAggregationType": "sum",
              "eventKey": "event-key-123abc"
            }
          ],
          "metrics": [
            {
              "key": "metric-key-123abc",
              "_versionId": "<string>",
              "name": "My metric",
              "kind": "custom",
              "_links": {
                "self": {
                  "href": "/api/v2/metrics/my-project/my-metric",
                  "type": "application/json"
                }
              },
              "isGroup": true,
              "isNumeric": true,
              "eventKey": "event-key-123abc",
              "metrics": [
                {
                  "key": "metric-key-123abc",
                  "name": "Example metric",
                  "kind": "custom",
                  "_links": {
                    "self": {
                      "href": "/api/v2/metrics/my-project/my-metric",
                      "type": "application/json"
                    }
                  },
                  "_versionId": "version-id-123abc",
                  "isNumeric": true,
                  "unitAggregationType": "sum",
                  "eventKey": "event-key-123abc",
                  "nameInGroup": "Step 1",
                  "randomizationUnits": [
                    "user"
                  ]
                }
              ]
            }
          ],
          "layerSnapshot": {
            "key": "checkout-flow",
            "name": "Checkout Flow",
            "reservationPercent": 10,
            "otherReservationPercent": 70
          },
          "covariateInfo": {
            "id": "74a49a2b-4834-4246-917e-5d85231d8c2a",
            "fileName": "covariate.csv",
            "createdAt": "1654104600000"
          }
        }
      ],
      "analysisConfig": {
        "bayesianThreshold": "<string>",
        "significanceThreshold": "<string>",
        "testDirection": "<string>",
        "multipleComparisonCorrectionMethod": "bonferroni",
        "multipleComparisonCorrectionScope": "variations",
        "sequentialTestingEnabled": true
      }
    }
  ],
  "total_count": 123,
  "_links": {}
}

Authorizations

Authorization · string · header · required

Path Parameters

projectKey · string<string> · required

The project key

environmentKey · string<string> · required

The environment key

Query Parameters

limit · integer<int64>

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

offset · integer<int64>

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.

filter · string<string>

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

expand · string<string>

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

lifecycleState · string<string>

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

Response

200

application/json

Experiment collection response

items · object[] · required

An array of experiments

Show child attributes

total_count · integer

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

_links · object

The location and content type of related resources

Show child attributes