Skip to main content

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.

Attributes

FieldTypeDescription
nodeintegerNode identifier for the returned series
metricstringMetric identifier for the returned series
aggregationstringAggregation used for the response: avg, max, or sum
granularitystringGranularity of the returned points: 1m, 15m, or 60m
sourceGranularitystring | nullGranularity of the underlying stored metric data used to build the response. Returned as 1m, 60m, or null when no source data is available.
dataarrayTime-series entries for the requested range, sorted by ascending timestamp

Data entry attributes

FieldTypeDescription
timestampintegerUnix timestamp in milliseconds
smoothenednumber | nullMetric value for the timestamp, or null when the value is unavailable
corridorsobject | nullCorridor data for the timestamp, or null when corridor data is unavailable for that point

Corridor attributes

FieldTypeDescription
main.up, main.downnumber | nullUpper and lower bound of the main corridor
sup.up, sup.downnumber | nullUpper and lower bound of the superior corridor when available
inf.up, inf.downnumber | nullUpper and lower bound of the inferior corridor when available

Example

{
"node": 10,
"metric": "2b953ac0-f047-45e0-a8e4-bc66e0593eff",
"aggregation": "avg",
"granularity": "15m",
"sourceGranularity": "1m",
"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
}
}
}
]
}