Query Chart Series Data

Retrieves time series data based on configured series parameters

POST /api/v2/charts/series

cURL

basicTimeSeries

curl --request POST \
  --url https://api.hyperdx.io/api/v2/charts/series \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": 1647014400000,
  "endTime": 1647100800000,
  "granularity": "1h",
  "series": [
    {
      "sourceId": "65f5e4a3b9e77c001a123456",
      "aggFn": "count",
      "where": "SeverityText:error",
      "groupBy": []
    }
  ]
}
'

200

timeSeriesData

{
  "data": [
    {
      "ts_bucket": 1647014400000,
      "series_0.data": 42
    },
    {
      "ts_bucket": 1647018000000,
      "series_0.data": 37
    },
    {
      "ts_bucket": 1647021600000,
      "series_0.data": 53
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

series · object[] · required

Array of series configurations

Required array length: 1 - 5 elements

Show child attributes

startTime · number · required

Start timestamp in milliseconds

Example:

1647014400000

endTime · number · required

End timestamp in milliseconds

Example:

1647100800000

granularity · enum<string>

Time bucket size for aggregations

Available options: 30s, 1m, 5m, 10m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d, auto

Example:

"1h"

seriesReturnType · enum<string>

Format of the returned data

Available options: ratio, column

Example:

"column"

Response

200

application/json

Successfully retrieved time series data

data · object[]

Show child attributes