List measurements for a batch of metrics
List metric measurements, potentially filtered and aggregated. This operation mimics the capabilities found in GET /v1/metrics/{name}/measurements, extending it for an entire batch of metrics that can be requested at once, over the same time interval.
It is legal to request the same metric multiple times, using different aggregations. For example, both the total for the interval (scalar) and a time series can be read simultaneously, using two different entries in the request payload. Entries in the response can be matched with the respective requests by metric name. When more than one exist for the same name, an id can be provided to disambiguate. This property will be echoed back unchanged and can be used for some or all entries, regardless of whether metrics repeat.
By default, this endpoint will omit response entries that include no measurements. This is done only when the request contains enough information for the client to successfully match all responses back to their respective requests—i.e., when there is at most one entry for each combination of metric name and id. This provides a cleaner response, especially in case where multiple pages need to be traversed and data for most metric entries is exhausted early. Otherwise, empty entries will be included as well and the output will be fully positional. This positional mode can be forced with forcePositional.
Pages can be navigated by following the links returned in pageInfo. Those requests must also be POST and must include the same payload that was initially sent. Behavior is undefined otherwise.
Query parameters
Forces a positional response; see the operation description.
Number of items in a response page. Default varies by API.
Token for the requested page.
Request body
Example request
{
"metrics": [
{
"id": "throughput-series",
"name": "dbo.host.queries.tput",
"filter": "id:[id1,id2] category:moderate",
"groupBy": [
"query"
],
"preGroupBy": [
"host"
]
}
]
}Response
The request has succeeded.
Example response
{
"metrics": [
{
"id": "throughput-series",
"name": "dbo.host.queries.tput",
"bucketSizeInSeconds": 1
}
]
}