---
title: Get experiment analysis plan
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > API Reference > Experiments
---

> For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt).

{% callout %}
# Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com

{% alert level="danger" %}
This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}).
{% /alert %}

{% /callout %}

# Get experiment analysis plan{% #get-experiment-analysis-plan %}

{% tab title="v2" %}

| Datadog site      | API endpoint                                                                       |
| ----------------- | ---------------------------------------------------------------------------------- |
| ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan |
| ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan |
| app.datadoghq.eu  | GET https://api.datadoghq.eu/api/v2/experiments/{experiment_id}/analysis-plan      |
| app.ddog-gov.com  | GET https://api.ddog-gov.com/api/v2/experiments/{experiment_id}/analysis-plan      |
| us2.ddog-gov.com  | GET https://api.us2.ddog-gov.com/api/v2/experiments/{experiment_id}/analysis-plan  |
| uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan |
| app.datadoghq.com | GET https://api.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan     |
| us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan |
| us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/experiments/{experiment_id}/analysis-plan |

### Overview

Get the effective public statistical analysis settings for an experiment. has_custom_analysis_settings compares only settings the caller can edit; protocol-required differences from company defaults do not make the plan custom. This endpoint requires the `product_analytics_experiments_read` permission.

OAuth apps require the `product_analytics_experiments_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#experiments) to access this endpoint.



### Arguments

#### Path Parameters

| Name                            | Type   | Description                 |
| ------------------------------- | ------ | --------------------------- |
| experiment_id [*required*] | string | The UUID of the experiment. |

### Response

{% tab title="200" %}
OK
{% tab title="Model" %}
Response containing the analysis settings for an experiment.

| Parent field   | Field                                         | Type    | Description                                                                                                                               |
| -------------- | --------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
|                | data [*required*]                        | object  | Analysis plan resource with its identifier and settings.                                                                                  |
| data           | attributes                                    | object  | Statistical settings and duration targets in the saved analysis plan.                                                                     |
| attributes     | bayesian_prior                                | object  | Parameters of the prior distribution used for Bayesian analysis.                                                                          |
| bayesian_prior | degrees_of_freedom                            | double  | Degrees of freedom of the prior distribution.                                                                                             |
| bayesian_prior | standard_deviation                            | double  | Standard deviation of the prior distribution.                                                                                             |
| attributes     | confidence_interval_method                    | enum    | Statistical method used to calculate the experiment results. Allowed enum values: `Sequential,FixedSample,Bayesian,SequentialFixedHybrid` |
| attributes     | confidence_level                              | double  | Confidence level used for statistical analysis, expressed as a fraction.                                                                  |
| attributes     | cuped_lookback_period_days                    | int64   | Number of days of pre-experiment data used for CUPED variance reduction.                                                                  |
| attributes     | experiment_auto_end_days                      | int64   | Number of days configured for the experiment to end automatically.                                                                        |
| attributes     | experiment_min_duration                       | int64   | Minimum experiment duration in days configured in the analysis plan.                                                                      |
| attributes     | experiment_min_sample_size                    | int64   | Minimum sample size configured in the analysis plan.                                                                                      |
| attributes     | has_custom_analysis_settings                  | boolean | Whether the experiment has custom analysis settings.                                                                                      |
| attributes     | is_cuped_enabled                              | boolean | Whether CUPED uses pre-experiment data to reduce variance in the analysis.                                                                |
| attributes     | is_multiple_testing_correction_enabled        | boolean | Whether the analysis adjusts for testing multiple hypotheses.                                                                             |
| attributes     | preferential_bonferroni_primary_metric_weight | double  | Weight assigned to the primary metric in the preferential Bonferroni correction.                                                          |
| attributes     | target_duration_days                          | int64   | Planned experiment duration in days.                                                                                                      |
| data           | id [*required*]                          | uuid    | Identifier of the experiment whose analysis plan is returned.                                                                             |
| data           | type [*required*]                        | enum    | Analysis plans resource type. Allowed enum values: `analysis-plans`                                                                       |

{% /tab %}

{% tab title="Example" %}

```json
{
  "data": {
    "attributes": {
      "bayesian_prior": {
        "degrees_of_freedom": null,
        "standard_deviation": 0.05
      },
      "confidence_interval_method": "Bayesian",
      "confidence_level": 0.95,
      "cuped_lookback_period_days": 30,
      "experiment_auto_end_days": 0,
      "experiment_min_duration": 0,
      "experiment_min_sample_size": 0,
      "has_custom_analysis_settings": false,
      "is_cuped_enabled": true,
      "is_multiple_testing_correction_enabled": false,
      "preferential_bonferroni_primary_metric_weight": 0.5,
      "target_duration_days": 14
    },
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "type": "analysis-plans"
  }
}
```

{% /tab %}

{% /tab %}

{% tab title="400" %}
Malformed experiment ID.
{% tab title="Model" %}
API error response.

| Parent field | Field                    | Type     | Description                                                                     |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- |
|              | errors [*required*] | [object] | A list of errors.                                                               |
| errors       | detail                   | string   | A human-readable explanation specific to this occurrence of the error.          |
| errors       | meta                     | object   | Non-standard meta-information about the error                                   |
| errors       | source                   | object   | References to the source of the error.                                          |
| source       | header                   | string   | A string indicating the name of a single request header which caused the error. |
| source       | parameter                | string   | A string indicating which URI query parameter caused the error.                 |
| source       | pointer                  | string   | A JSON pointer to the value in the request document that caused the error.      |
| errors       | status                   | string   | Status code of the response.                                                    |
| errors       | title                    | string   | Short human-readable summary of the error.                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="401" %}
Unauthorized
{% tab title="Model" %}
API error response.

| Parent field | Field                    | Type     | Description                                                                     |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- |
|              | errors [*required*] | [object] | A list of errors.                                                               |
| errors       | detail                   | string   | A human-readable explanation specific to this occurrence of the error.          |
| errors       | meta                     | object   | Non-standard meta-information about the error                                   |
| errors       | source                   | object   | References to the source of the error.                                          |
| source       | header                   | string   | A string indicating the name of a single request header which caused the error. |
| source       | parameter                | string   | A string indicating which URI query parameter caused the error.                 |
| source       | pointer                  | string   | A JSON pointer to the value in the request document that caused the error.      |
| errors       | status                   | string   | Status code of the response.                                                    |
| errors       | title                    | string   | Short human-readable summary of the error.                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="403" %}
Forbidden
{% tab title="Model" %}
API error response.

| Parent field | Field                    | Type     | Description                                                                     |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- |
|              | errors [*required*] | [object] | A list of errors.                                                               |
| errors       | detail                   | string   | A human-readable explanation specific to this occurrence of the error.          |
| errors       | meta                     | object   | Non-standard meta-information about the error                                   |
| errors       | source                   | object   | References to the source of the error.                                          |
| source       | header                   | string   | A string indicating the name of a single request header which caused the error. |
| source       | parameter                | string   | A string indicating which URI query parameter caused the error.                 |
| source       | pointer                  | string   | A JSON pointer to the value in the request document that caused the error.      |
| errors       | status                   | string   | Status code of the response.                                                    |
| errors       | title                    | string   | Short human-readable summary of the error.                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="404" %}
Not Found
{% tab title="Model" %}
API error response.

| Parent field | Field                    | Type     | Description                                                                     |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- |
|              | errors [*required*] | [object] | A list of errors.                                                               |
| errors       | detail                   | string   | A human-readable explanation specific to this occurrence of the error.          |
| errors       | meta                     | object   | Non-standard meta-information about the error                                   |
| errors       | source                   | object   | References to the source of the error.                                          |
| source       | header                   | string   | A string indicating the name of a single request header which caused the error. |
| source       | parameter                | string   | A string indicating which URI query parameter caused the error.                 |
| source       | pointer                  | string   | A JSON pointer to the value in the request document that caused the error.      |
| errors       | status                   | string   | Status code of the response.                                                    |
| errors       | title                    | string   | Short human-readable summary of the error.                                      |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}
```

{% /tab %}

{% /tab %}

{% tab title="429" %}
Too many requests
{% tab title="Model" %}
API error response.

| Field                    | Type     | Description       |
| ------------------------ | -------- | ----------------- |
| errors [*required*] | [string] | A list of errors. |

{% /tab %}

{% tab title="Example" %}

```json
{
  "errors": [
    "Bad Request"
  ]
}
```

{% /tab %}

{% /tab %}

### Code Example

##### 
                  \# Path parameters export experiment_id="550e8400-e29b-41d4-a716-446655440000" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"  \# Curl command curl -X GET "https://api.datadoghq.com/api/v2/experiments/${experiment_id}/analysis-plan" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" 
                
{% /tab %}
