Query impact metrics time series data

GET

https://app.unleash-instance.example.com/api/admin/impact-metrics

GET

/api/admin/impact-metrics

$ curl -G https://app.unleash-instance.example.com/api/admin/impact-metrics \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d metricName=http_requests_total \
>      -d range=day \
>      -d aggregationMode=rps \
>      -d source=external \
>      --data-urlencode labels={"endpoint":["/api/admin"]} \
>      -d mode=display

1 {
2   "start": "1712745600",
3   "end": "1712832000",
4   "step": "15m",
5   "series": [
6     {
7       "metric": {
8         "endpoint": "/api/admin",
9         "method": "GET",
10         "status": "200"
11       },
12       "data": [
13         [
14           1712745600,
15           "120"
16         ],
17         [
18           1712746500,
19           "135"
20         ],
21         [
22           1712747400,
23           "150"
24         ]
25       ]
26     }
27   ],
28   "labels": {
29     "endpoint": [
30       "/api/admin",
31       "/api/user",
32       "/api/metrics"
33     ],
34     "method": [
35       "GET",
36       "POST",
37       "PUT"
38     ],
39     "status": [
40       "200",
41       "404",
42       "500"
43     ]
44   },
45   "debug": {
46     "query": "sum(rate(http_requests_total{endpoint=\"/api/admin\"}[1m])) by (method, status)",
47     "metricType": "counter",
48     "isTruncated": false
49   }
50 }

Enterprise feature

Queries an impact metric source for time series data based on the provided metric name, time range, and aggregation mode.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Query parameters

metricNamestringRequired

The Prometheus metric name to query.

rangeenumRequired

The time range for the query.

aggregationModeenumRequired

The aggregation mode for the query.

labelsstringOptional

A JSON-encoded object mapping label names to arrays of label values to filter by.

modeenumOptional

Query mode. edit (default) also returns the available labels for the metric (used by filter UIs). display skips label discovery and returns time-series data only (cheaper; use for dashboard rendering).

Allowed values:

sourceenumRequiredDefaults to internal

Whether the metric comes from the internal Unleash impact metrics or an external source.

Allowed values:

Response

impactMetricsDataSchema

startstring

The start of the queried time range as a Unix epoch timestamp in seconds.

endstring

The end of the queried time range as a Unix epoch timestamp in seconds.

stepstring

The step interval between data points.

serieslist of objects

Array of time series results.

labelsmap from strings to lists of strings

Available label values for the queried metric, keyed by label name.

debugobject

Internal debug information. This field is not part of the public API and may be removed without notice.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error