GET https://api.ap1.datadoghq.com/api/v2/experiments/metric-collections https://api.ap2.datadoghq.com/api/v2/experiments/metric-collections https://api.datadoghq.eu/api/v2/experiments/metric-collections https://api.ddog-gov.com/api/v2/experiments/metric-collections https://api.us2.ddog-gov.com/api/v2/experiments/metric-collections https://api.uk1.datadoghq.com/api/v2/experiments/metric-collections https://api.datadoghq.com/api/v2/experiments/metric-collections https://api.us3.datadoghq.com/api/v2/experiments/metric-collections 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 to access this endpoint.
Arguments Query Strings Optional fields to include. Repeat this parameter to request several fields. counts adds metric_count.
Number of results per page. The default is 25. Values above 50 are reduced to 50.
Number of results to skip before returning this page.
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 by one field: name, created_at, or updated_at. Prefix with - for descending order. The
default is -created_at.
Response OK
List of metric collection resources with pagination information.
Expand All
Resources returned in this response.
Details of the metric collection.
Time when this resource was created.
Text that explains the metric collection.
Whether the collection is used for guardrail metrics.
Number of metrics in this collection.
Metrics included in this collection.
ID of the metric represented by this entry.
Display name of the metric represented by this entry.
Display name of the metric collection.
Time when this resource was last updated.
ID of the metric collection.
Metric collections resource type.
Allowed enum values: metric-collections
default: metric-collections
Links for navigating a paginated result set.
URL of the first page of results.
URL of the last page of results.
URL of the next page of results.
URL of the previous page of results.
URL of the current page of results.
Pagination information for a list response.
Result counts and offsets for a page of results.
Offset of the first page of results.
Offset of the last page of results.
Maximum number of results returned in one page.
Offset of the next page of results.
Number of results skipped before this page.
Offset of the previous page of results.
Total number of matching results across all pages.
Pagination method used for this result set.
{
"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"
}
}
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Forbidden
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# 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.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/experiments/metric-collections " \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN} "