Get experiment
Get details about an experiment.
Expanding the experiment response
LaunchDarkly supports four 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.
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.
Path parameters
projectKey
The project key
environmentKey
The environment key
experimentKey
The experiment key
Headers
Authorization
Query parameters
expand
A comma-separated list of properties that can reveal additional information in the response. Supported fields are explained above.
Response
Experiment response
key
The experiment key
name
The experiment name
_maintainerId
The ID of the member who maintains this experiment.
_creationDate
Timestamp of when the experiment was created
environmentKey
_links
The location and content type of related resources
_id
The experiment ID
description
The experiment description
archivedDate
Timestamp of when the experiment was archived
holdoutId
The holdout ID
currentIteration
Details on the current iteration
draftIteration
Details on the current iteration. This iteration may be already started, or may still be a draft.
previousIterations
Details on the previous iterations for this experiment.