Query Chart Series Data

POST/api/v2/charts/series

Retrieves time series data based on configured series parameters

Authorizations

AuthorizationBearer API Keyheaderrequired
`Authorization: Bearer <token>`

Request bodyJSON

seriesarray ofobjectrequired
Array of series configurations
8 properties
- sourceIdstringrequired
  ID of the data source for this series
  
  Example: "65f5e4a3b9e77c001a123456"
- aggFnavgorcountorcount_distinctorlast_valueormaxormin+2 morerequired
  Aggregation function to use on the data
  
  Example: "count"
- wherestringrequired
  Filter condition in Lucene query syntax
  
  Example: "service:api AND level:error"
- groupByarray ofstringrequired
  Fields to group the results by
  
  Example: ["service","host"]
- fieldoptionalstring
  Field to aggregate
  
  Example: "duration"
- whereLanguageoptionalluceneorsql
  Query language used in the where clause
  
  Example: "lucene"
- metricNameoptionalstring
  Name of the metric (for metric data sources)
  
  Example: "http_requests_total"
- metricDataTypeoptionalsumorgaugeorhistogram
  Type of metric data
  
  Example: "gauge"
startTimenumberrequired
Start timestamp in milliseconds

Example: 1647014400000
endTimenumberrequired
End timestamp in milliseconds

Example: 1647100800000
granularityoptional30sor1mor5mor10mor15mor30m+9 more
Time bucket size for aggregations

Example: "1h"
seriesReturnTypeoptionalratioorcolumn
Format of the returned data

Example: "column"

Response

JSON

200

Successfully retrieved time series data

JSON

dataoptionalarray ofobject
Array of data points for the series
4 properties
- ts_bucketoptionalnumber
  Timestamp of the data point (bucket start time)
  
  Example: 1647014400000
- dataoptionalnumber
  Value for the first series
  
  Example: 42
- dataoptionalnumber
  Value for the second series
  
  Example: 18
- groupoptionalarray ofstring
  Group by values if groupBy was specified
  
  Example: ["api","prod-host-1"]

Query Chart Series Data

curl --request POST \
  --url /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": []
    }
  ]
}
'

const url = '/api/v2/charts/series';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    startTime: 1647014400000,
    endTime: 1647100800000,
    granularity: '1h',
    series: [
      {
        sourceId: '65f5e4a3b9e77c001a123456',
        aggFn: 'count',
        where: 'SeverityText:error',
        groupBy: []
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "/api/v2/charts/series"

payload = {
    "startTime": 1647014400000,
    "endTime": 1647100800000,
    "granularity": "1h",
    "series": [
        {
            "sourceId": "65f5e4a3b9e77c001a123456",
            "aggFn": "count",
            "where": "SeverityText:error",
            "groupBy": []
        }
    ]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

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

{
  "error": "All series must have the same groupBy fields"
}

{
  "error": "Team context missing"
}

{
  "error": "Source not found"
}

{
  "error": "Internal server error"
}

Authorizations

Request bodyJSON

Response

200

400

403

404

500