Metric data response object
A Metric data response object represents time-series metric values together with corridor data for a single node and metric pair.
Notes
nodeandmetricidentify the requested metric seriesaggregationis either provided explicitly or resolved automatically by the APIdatais sorted by ascending timestamp
Attributes
| Field | Type | Description |
|---|---|---|
node | integer | Node identifier |
metric | string | Metric identifier |
aggregation | string | Aggregation used for the response: avg, max, or sum |
data | array | Time-series entries for the requested range |
Data entry attributes
| Field | Type | Description |
|---|---|---|
timestamp | integer | Unix timestamp in milliseconds |
smoothened | number | Smoothed metric value used by the API response |
corridors | object | null | Corridor data mapped for the timestamp, or null when no corridor data is available |
Corridor attributes
| Field | Type | Description |
|---|---|---|
main.up, main.down | number | Upper & lower bound of the main corridor |
sup.up, sup.down | number | null | Lower bound of the superior corridor when available |
inf.up, inf.down | number | null | Upper & lower bound of the inferior corridor when available |
Example
{
"node": 10,
"metric": "2b953ac0-f047-45e0-a8e4-bc66e0593eff",
"aggregation": "avg",
"data": [
{
"timestamp": 1763035200000,
"smoothened": 42.1,
"corridors": {
"main": {
"up": 45.3,
"down": 39.4
},
"sup": {
"up": 47.8,
"down": 37.1
},
"inf": {
"up": 43.6,
"down": 40.8
}
}
}
]
}