Get categorical stats time series

GET

///v1/stats

GET

/v1/stats

curl -G /v1/stats \
     -d dataSource=inband \
     -d groupBy=nodegroup \
     -d groupId=550e8400-e29b-41d4-a716-446655440000 \
     -d name=agentStatus \
     -d window=240h

{
  "series": [
    {
      "name": "Online",
      "values": [
        100,
        105,
        null,
        103,
        108,
        110,
        109,
        null,
        111,
        113
      ]
    },
    {
      "name": "Offline",
      "values": [
        80,
        90,
        null,
        87,
        82,
        81,
        84,
        null,
        80,
        79
      ]
    }
  ],
  "timeRange": {
    "end": "2024-07-06T15:30:00Z",
    "start": "2024-06-26T15:30:00Z"
  },
  "timestamps": [
    1719489600,
    1719576000,
    1719662400,
    1719748800,
    1719835200,
    1719921600,
    1720008000,
    1720094400,
    1720180800,
    1720279800
  ]
}

Returns aligned daily categorical chart data for a customer, node group, or compute zone over a trailing window ending at the current server time. Historical points come from stored stats. The final point is calculated live at request time and replaces any stored data for the current day. A missing historical record retains its scheduled timestamp and has null at the same index in every series; zero is an observed count. timestamps[i] identifies the point for every series.values[i], and all arrays have the same length. The agentStatus stat currently returns Online and Offline series in that order and requires dataSource. Healthy liveness counts as Online; every other, missing, or unrecognized liveness value counts as Offline.

Query parameters

nameenumRequired

The stat to query

Allowed values:

dataSourceenumOptional

Data source to query. Required for agentStatus.

Allowed values:

groupByenumRequired

The aggregation level to group stats by

Allowed values:

groupIdstringOptional

Entity ID. Required when groupBy is nodegroup or computezone; omit when groupBy is customer.

windowstringRequired

Trailing daily window ending at the current server time. Must be a positive whole multiple of 24h and cannot exceed 8760h (365 days); use 240h for 10 days. ‘d’ is not supported.

Response

Categorical time series for the requested stat

serieslist of objectsOptional

timeRangeobjectOptional

timestampslist of integersOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

499

Client Closed Request Error

500

Internal Server Error

503

Service Unavailable Error