---
title: "Get experiments"
method: GET
path: "/api/v2/projects/{projectKey}/environments/{environmentKey}/experiments"
tags: ["Experiments"]
---

# Get experiments

`GET /api/v2/projects/{projectKey}/environments/{environmentKey}/experiments`

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.

## Path parameters

- `projectKey` string, string, required — The project key
- `environmentKey` string, string, required — The environment key

## Query parameters

- `limit` integer — The maximum number of experiments to return. Defaults to 20.
- `offset` integer — 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`

Experiment collection response

- ExperimentCollectionRep
  - `items` Experiment[], required — An array of experiments
    - `_id` string — The experiment ID
    - `key` string, required — The experiment key
    - `name` string, required — The experiment name
    - `description` string — The experiment description
    - `_maintainerId` string, required — The ID of the member who maintains this experiment.
    - `_creationDate` integer, required
    - `environmentKey` string, required
    - `archivedDate` integer
    - `tags` string[] — Tags for the experiment
    - `_links` object, required — The location and content type of related resources
    - `holdoutId` string — The holdout ID
    - `currentIteration` IterationRep
      - `_id` string — The iteration ID
      - `hypothesis` string, required — The expected outcome of this experiment
      - `status` 'not_started' | 'running' | 'stopped', required — The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
      - `createdAt` integer, required
      - `startedAt` integer
      - `endedAt` integer
      - `winningTreatmentId` string — The ID of the treatment chosen when the experiment stopped
      - `winningReason` string — The reason you stopped the experiment
      - `canReshuffleTraffic` boolean — Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).
      - `flags` object — Details on the flag used in this experiment
      - `reallocationFrequencyMillis` integer — The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.
      - `version` integer — The current version that the iteration is on
      - `primaryMetric` DependentMetricOrMetricGroupRep
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `primarySingleMetric` MetricV2Rep
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `primaryFunnel` DependentMetricGroupRepWithMetrics
        - `key` string, required — A unique key to reference the metric group
        - `name` string, required — A human-friendly name for the metric group
        - `kind` 'funnel' | 'standard' | 'guardrail', required — The type of the metric group
        - `_links` object, required — The location and content type of related resources
        - `metrics` MetricInGroupRep[] — The metrics in the metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `randomizationUnit` string — The unit of randomization for this iteration
      - `attributes` string[] — The available attribute filters for this iteration
      - `treatments` TreatmentRep[] — Details on the variations you are testing in the experiment
        - `_id` string — The treatment ID. This is the variation ID from the flag.
        - `name` string, required — The treatment name. This is the variation name from the flag.
        - `allocationPercent` string, required — The percentage of traffic allocated to this treatment during the iteration
        - `baseline` boolean — Whether this treatment is the baseline to compare other treatments against
        - `parameters` ParameterRep[] — Details on the flag and variation used for this treatment
          - `variationId` string
          - `flagKey` string
      - `secondaryMetrics` MetricV2Rep[] — Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `metrics` DependentMetricOrMetricGroupRep[] — Details on the metrics for this experiment
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `layerSnapshot` LayerSnapshotRep
        - `key` string, required — Key of the layer the experiment was part of
        - `name` string, required — Layer name at the time this experiment iteration was stopped
        - `reservationPercent` integer, required — Percent of layer traffic that was reserved in the layer for this experiment iteration
        - `otherReservationPercent` integer, required — Percent of layer traffic that was reserved for other experiments in the same environment, when this experiment iteration was stopped
    - `draftIteration` IterationRep
      - `_id` string — The iteration ID
      - `hypothesis` string, required — The expected outcome of this experiment
      - `status` 'not_started' | 'running' | 'stopped', required — The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
      - `createdAt` integer, required
      - `startedAt` integer
      - `endedAt` integer
      - `winningTreatmentId` string — The ID of the treatment chosen when the experiment stopped
      - `winningReason` string — The reason you stopped the experiment
      - `canReshuffleTraffic` boolean — Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).
      - `flags` object — Details on the flag used in this experiment
      - `reallocationFrequencyMillis` integer — The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.
      - `version` integer — The current version that the iteration is on
      - `primaryMetric` DependentMetricOrMetricGroupRep
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `primarySingleMetric` MetricV2Rep
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `primaryFunnel` DependentMetricGroupRepWithMetrics
        - `key` string, required — A unique key to reference the metric group
        - `name` string, required — A human-friendly name for the metric group
        - `kind` 'funnel' | 'standard' | 'guardrail', required — The type of the metric group
        - `_links` object, required — The location and content type of related resources
        - `metrics` MetricInGroupRep[] — The metrics in the metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `randomizationUnit` string — The unit of randomization for this iteration
      - `attributes` string[] — The available attribute filters for this iteration
      - `treatments` TreatmentRep[] — Details on the variations you are testing in the experiment
        - `_id` string — The treatment ID. This is the variation ID from the flag.
        - `name` string, required — The treatment name. This is the variation name from the flag.
        - `allocationPercent` string, required — The percentage of traffic allocated to this treatment during the iteration
        - `baseline` boolean — Whether this treatment is the baseline to compare other treatments against
        - `parameters` ParameterRep[] — Details on the flag and variation used for this treatment
          - `variationId` string
          - `flagKey` string
      - `secondaryMetrics` MetricV2Rep[] — Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `metrics` DependentMetricOrMetricGroupRep[] — Details on the metrics for this experiment
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `layerSnapshot` LayerSnapshotRep
        - `key` string, required — Key of the layer the experiment was part of
        - `name` string, required — Layer name at the time this experiment iteration was stopped
        - `reservationPercent` integer, required — Percent of layer traffic that was reserved in the layer for this experiment iteration
        - `otherReservationPercent` integer, required — Percent of layer traffic that was reserved for other experiments in the same environment, when this experiment iteration was stopped
    - `previousIterations` IterationRep[] — Details on the previous iterations for this experiment.
      - `_id` string — The iteration ID
      - `hypothesis` string, required — The expected outcome of this experiment
      - `status` 'not_started' | 'running' | 'stopped', required — The status of the iteration: <code>not_started</code>, <code>running</code>, <code>stopped</code>
      - `createdAt` integer, required
      - `startedAt` integer
      - `endedAt` integer
      - `winningTreatmentId` string — The ID of the treatment chosen when the experiment stopped
      - `winningReason` string — The reason you stopped the experiment
      - `canReshuffleTraffic` boolean — Whether the experiment may reassign traffic to different variations when the experiment audience changes (true) or must keep all traffic assigned to its initial variation (false).
      - `flags` object — Details on the flag used in this experiment
      - `reallocationFrequencyMillis` integer — The cadence (in milliseconds) to update the allocation. Only present for multi-armed bandits.
      - `version` integer — The current version that the iteration is on
      - `primaryMetric` DependentMetricOrMetricGroupRep
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `primarySingleMetric` MetricV2Rep
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `primaryFunnel` DependentMetricGroupRepWithMetrics
        - `key` string, required — A unique key to reference the metric group
        - `name` string, required — A human-friendly name for the metric group
        - `kind` 'funnel' | 'standard' | 'guardrail', required — The type of the metric group
        - `_links` object, required — The location and content type of related resources
        - `metrics` MetricInGroupRep[] — The metrics in the metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `randomizationUnit` string — The unit of randomization for this iteration
      - `attributes` string[] — The available attribute filters for this iteration
      - `treatments` TreatmentRep[] — Details on the variations you are testing in the experiment
        - `_id` string — The treatment ID. This is the variation ID from the flag.
        - `name` string, required — The treatment name. This is the variation name from the flag.
        - `allocationPercent` string, required — The percentage of traffic allocated to this treatment during the iteration
        - `baseline` boolean — Whether this treatment is the baseline to compare other treatments against
        - `parameters` ParameterRep[] — Details on the flag and variation used for this treatment
          - `variationId` string
          - `flagKey` string
      - `secondaryMetrics` MetricV2Rep[] — Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment.
        - `key` string, required — The metric key
        - `_versionId` string — The version ID of the metric
        - `name` string, required — The metric name
        - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
      - `metrics` DependentMetricOrMetricGroupRep[] — Details on the metrics for this experiment
        - `key` string, required — A unique key to reference the metric or metric group
        - `_versionId` string, required — The version ID of the metric or metric group
        - `name` string, required — A human-friendly name for the metric or metric group
        - `kind` 'pageview' | 'click' | 'custom' | 'funnel' | 'standard' | 'guardrail', required — If this is a metric, then it represents the kind of event the metric tracks. If this is a metric group, then it represents the group type
        - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
        - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
        - `_links` object, required — The location and content type of related resources
        - `isGroup` boolean, required — Whether this is a metric group or a metric
        - `metrics` MetricInGroupRep[] — An ordered list of the metrics in this metric group
          - `key` string, required — The metric key
          - `_versionId` string — The version ID of the metric
          - `name` string, required — The metric name
          - `kind` 'pageview' | 'click' | 'custom', required — The kind of event the metric tracks
          - `isNumeric` boolean — For custom metrics, whether to track numeric changes in value against a baseline (<code>true</code>) or to track a conversion when an end user takes an action (<code>false</code>).
          - `unitAggregationType` 'sum' | 'average' — The type of unit aggregation to use for the metric
          - `eventKey` string — The event key sent with the metric. Only relevant for custom metrics.
          - `_links` object, required — The location and content type of related resources
          - `nameInGroup` string — Name of the metric when used within the associated metric group. Can be different from the original name of the metric. Required if and only if the metric group is a <code>funnel</code>.
          - `randomizationUnits` string[] — The randomization units for the metric
      - `layerSnapshot` LayerSnapshotRep
        - `key` string, required — Key of the layer the experiment was part of
        - `name` string, required — Layer name at the time this experiment iteration was stopped
        - `reservationPercent` integer, required — Percent of layer traffic that was reserved in the layer for this experiment iteration
        - `otherReservationPercent` integer, required — Percent of layer traffic that was reserved for other experiments in the same environment, when this experiment iteration was stopped
  - `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

## Other responses

- `400` — Invalid request
- `401` — Invalid access token
- `403` — Forbidden
- `404` — Invalid resource identifier
- `405` — Method not allowed
- `429` — Rate limited

## Changes

- **2026-02-28** `69c5c9aafe78` — 9 warning, 28 info
  - added the new `not_started` enum value to the `items/items/currentIteration/status` response property for the response status `200`
  - added the new `not_started` enum value to the `items/items/draftIteration/status` response property for the response status `200`
  - added the new `not_started` enum value to the `items/items/previousIterations/items/status` response property for the response status `200`
  - added the new `running` enum value to the `items/items/currentIteration/status` response property for the response status `200`
  - …33 more
- **2025-07-08** `b2724c5174d1` — 9 warning
  - added the new `guardrail` enum value to the `items/items/currentIteration/metrics/items/kind` response property for the response status `200`
  - added the new `guardrail` enum value to the `items/items/currentIteration/primaryFunnel/kind` response property for the response status `200`
  - added the new `guardrail` enum value to the `items/items/currentIteration/primaryMetric/kind` response property for the response status `200`
  - added the new `guardrail` enum value to the `items/items/draftIteration/metrics/items/kind` response property for the response status `200`
  - …5 more

[Change history](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api/changes/api/v2/projects/:projectKey/environments/:environmentKey/experiments/get.md)

---

[API](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api.md) · [All operations](https://skmtc.dev/launchdarkly/apis/launchdarkly-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/launchdarkly/launchdarkly-rest-api/revisions/69c5c9aafe78/schema)