v1

latestOpenAPI 3.0.02026-07-1738124256.1 KB

Charts

Query Chart Series Data

Retrieves time series data based on configured series parameters

post/api/v2/charts/series

Request body

startTimenumber required

Start timestamp in milliseconds

endTimenumber required

End timestamp in milliseconds

granularity'30s' | '1m' | '5m' | '10m' | '15m' | '30m' | '1h' | '2h' | '6h' | '12h' | '1d' | '2d' | '7d' | '30d' | 'auto'

Time bucket size for aggregations

seriesReturnType'ratio' | 'column'

Format of the returned data

Example request

{
  "series": [
    {
      "sourceId": "65f5e4a3b9e77c001a123456",
      "aggFn": "count",
      "field": "duration",
      "where": "service:api AND level:error",
      "whereLanguage": "lucene",
      "groupBy": [
        "service",
        "host"
      ],
      "metricName": "http_requests_total",
      "metricDataType": "gauge"
    }
  ],
  "startTime": 1647014400000,
  "endTime": 1647100800000,
  "granularity": "1h",
  "seriesReturnType": "column"
}

Response

Successfully retrieved time series data

Example response

{
  "data": [
    {
      "ts_bucket": 1647014400000,
      "series_0.data": 42,
      "series_1.data": 18,
      "group": [
        "api",
        "prod-host-1"
      ]
    }
  ]
}