---
title: List experiment protocols
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 %}

# List experiment protocols{% #list-experiment-protocols %}

{% tab title="v2" %}

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

### Overview

List draft, published, and archived experiment protocols. Omit filter[status] to return all statuses. Only published protocols can be used to create experiments. 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

#### Query Strings

| Name                      | Type    | Description                                                                                                                                                                            |
| ------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filter[status]            | array   | Filter by protocol status. Repeat this parameter to select more than one status.                                                                                                       |
| filter[primary_metric_id] | string  | Filter by the UUID of the primary metric in the protocol template.                                                                                                                     |
| filter[query]             | string  | Find protocols whose names contain the search text, regardless of case. Leading and trailing spaces are ignored. Blank values apply no filter. The maximum length is 1024 UTF-8 bytes. |
| filter[subject_type_id]   | string  | Filter by the UUID of the subject type in the protocol template.                                                                                                                       |
| page[limit]               | integer | Number of results per page. The default is 25. Values above 50 are reduced to 50.                                                                                                      |
| page[offset]              | integer | Number of results to skip before returning this page.                                                                                                                                  |
| sort                      | string  | Sort by `name`, `subject_type_name`, `primary_metric_name`, or `updated_at`. Prefix with `-` for descending order. The default is `-updated_at`.                                       |

### Response

{% tab title="200" %}
OK
{% tab title="Model" %}
List of protocol resources with pagination information.

| Parent field   | Field                        | Type     | Description                                                                                          |
| -------------- | ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|                | data [*required*]       | [object] | Resources returned in this response.                                                                 |
| data           | attributes                   | object   | Summary of the protocol and its selected subject type and primary metric.                            |
| attributes     | description                  | string   | Text that explains the protocol.                                                                     |
| attributes     | name [*required*]       | string   | Display name of the protocol.                                                                        |
| attributes     | primary_metric               | object   | Subject type selected by the protocol.                                                               |
| primary_metric | id                           | string   | ID of the subject type.                                                                              |
| primary_metric | name                         | string   | Display name of the subject type.                                                                    |
| attributes     | primary_metric_id            | string   | ID of the primary metric supplied by the protocol.                                                   |
| attributes     | status [*required*]     | enum     | Publication status of the protocol. Allowed enum values: `DRAFT,PUBLISHED,ARCHIVED`                  |
| attributes     | subject_type                 | object   | Subject type selected by the protocol.                                                               |
| subject_type   | id                           | string   | ID of the subject type.                                                                              |
| subject_type   | name                         | string   | Display name of the subject type.                                                                    |
| attributes     | subject_type_id              | string   | ID of the subject type used by this configuration.                                                   |
| attributes     | updated_at [*required*] | string   | RFC3339 update time. Preserve all fractional seconds when passing this value as expected_updated_at. |
| data           | id [*required*]         | uuid     | ID of the protocol.                                                                                  |
| data           | type [*required*]       | enum     | Protocols resource type. Allowed enum values: `protocols`                                            |
|                | links                        | object   | Links for navigating a paginated result set.                                                         |
| links          | first                        | string   | URL of the first page of results.                                                                    |
| links          | last                         | string   | URL of the last page of results.                                                                     |
| links          | next                         | string   | URL of the next page of results.                                                                     |
| links          | prev                         | string   | URL of the previous page of results.                                                                 |
| links          | self                         | string   | URL of the current page of results.                                                                  |
|                | meta                         | object   | Pagination information for a list response.                                                          |
| meta           | page                         | object   | Result counts and offsets for a page of results.                                                     |
| page           | first_offset                 | int64    | Offset of the first page of results.                                                                 |
| page           | last_offset                  | int64    | Offset of the last page of results.                                                                  |
| page           | limit                        | int64    | Maximum number of results returned in one page.                                                      |
| page           | next_offset                  | int64    | Offset of the next page of results.                                                                  |
| page           | offset                       | int64    | Number of results skipped before this page.                                                          |
| page           | prev_offset                  | int64    | Offset of the previous page of results.                                                              |
| page           | total                        | int64    | Total number of matching results across all pages.                                                   |
| page           | type                         | string   | Pagination method used for this result set.                                                          |

{% /tab %}

{% tab title="Example" %}

```json
{
  "data": [
    {
      "attributes": {
        "description": "string",
        "name": "Checkout conversion",
        "primary_metric": {
          "id": "string",
          "name": "string"
        },
        "primary_metric_id": "string",
        "status": "PUBLISHED",
        "subject_type": {
          "id": "string",
          "name": "string"
        },
        "subject_type_id": "string",
        "updated_at": "2026-01-01T00:00:00Z"
      },
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "protocols"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_offset": "integer",
      "last_offset": "integer",
      "limit": "integer",
      "next_offset": "integer",
      "offset": "integer",
      "prev_offset": "integer",
      "total": "integer",
      "type": "string"
    }
  }
}
```

{% /tab %}

{% /tab %}

{% tab title="400" %}
Bad Request
{% 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="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

##### 
                  \# 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/protocols" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" 
                
{% /tab %}
