---
title: List metric collections
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 metric collections{% #list-metric-collections %}
Copy pageCopied
{% tab title="v2" %}

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

### Overview

List metric collections for the organization. Collections are reusable ordered metric sets; attaching one to an experiment creates an independent snapshot. This endpoint requires the `product_analytics_metrics_read` permission.

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



### Arguments

#### Query Strings

| Name         | Type    | Description                                                                                                                                                                              |
| ------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| include      | array   | Optional fields to include. Repeat this parameter to request several fields. `counts` adds metric_count.                                                                                 |
| 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.                                                                                                                                    |
| search       | string  | Find collections 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. |
| sort         | string  | Sort by one field: `name`, `created_at`, or `updated_at`. Prefix with `-` for descending order. The default is `-created_at`.                                                            |

### Response

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

| Parent field | Field                  | Type      | Description                                                                 |
| ------------ | ---------------------- | --------- | --------------------------------------------------------------------------- |
|              | data [*required*] | [object]  | Resources returned in this response.                                        |
| data         | attributes             | object    | Details of the metric collection.                                           |
| attributes   | created_at             | date-time | Time when this resource was created.                                        |
| attributes   | description            | string    | Text that explains the metric collection.                                   |
| attributes   | is_guardrail           | boolean   | Whether the collection is used for guardrail metrics.                       |
| attributes   | metric_count           | int64     | Number of metrics in this collection.                                       |
| attributes   | metrics                | [object]  | Metrics included in this collection.                                        |
| metrics      | metric_id              | string    | ID of the metric represented by this entry.                                 |
| metrics      | metric_name            | string    | Display name of the metric represented by this entry.                       |
| attributes   | name                   | string    | Display name of the metric collection.                                      |
| attributes   | updated_at             | date-time | Time when this resource was last updated.                                   |
| data         | id [*required*]   | uuid      | ID of the metric collection.                                                |
| data         | type [*required*] | enum      | Metric collections resource type. Allowed enum values: `metric-collections` |
|              | 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": {
        "created_at": "2019-09-19T10:00:00.000Z",
        "description": "string",
        "is_guardrail": false,
        "metric_count": "integer",
        "metrics": [
          {
            "metric_id": "string",
            "metric_name": "string"
          }
        ],
        "name": "string",
        "updated_at": "2019-09-19T10:00:00.000Z"
      },
      "id": "550e8400-e29b-41d4-a716-446655440023",
      "type": "metric-collections"
    }
  ],
  "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/metric-collections" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" 
                
{% /tab %}
