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.

Notes

  • node and metric identify the requested metric series
  • aggregation is either provided explicitly or resolved automatically by the API
  • data is sorted by ascending timestamp

Attributes

FieldTypeDescription
nodeintegerNode identifier
metricstringMetric identifier
aggregationstringAggregation used for the response: avg, max, or sum
dataarrayTime-series entries for the requested range

Data entry attributes

FieldTypeDescription
timestampintegerUnix timestamp in milliseconds
smoothenednumberSmoothed metric value used by the API response
corridorsobject | nullCorridor data mapped for the timestamp, or null when no corridor data is available

Corridor attributes

FieldTypeDescription
main.up, main.downnumberUpper & lower bound of the main corridor
sup.up, sup.downnumber | nullLower bound of the superior corridor when available
inf.up, inf.downnumber | nullUpper & 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
}
}
}
]
}