Historical Data

Get historical data in JSON format

GET https://<host>/api/historical-data/json

Note: You must ensure that your tag names are URL encoded before being sent. For example, a space character would be replaced by the character sequence %20.

Query Parameters

NameTypeDescription

tags*

string[]

tags to get data for. You can pass multiple, e.g. `?tags=temperature&tags=pressure

beginTime*

number

beginning of requested time range, milliseconds since Jan 1 1970 UTC

endTime*

number

end of requested time range, milliseconds since Jan 1 1970 UTC

interval

number

requested time interval between data points, in milliseconds. If none is given, raw full-resolution data is returned

includeAverage

boolean

defaults to true; whether to include the average value in each time range (v arrays in response)

includeMin

boolean

whether to include the minimum value in each time interval (min property)

includeMax

string

whether to include the minimum value in each time interval (max property)

lookbackMode

string

none, actual or normalized. Defaults to none if interval is not given, normalized otherwise. actual will include the last raw point within timeout range before beginTime, if any; normalized will add a point at beginTime with the value of the last point within timeout range before beginTime, if any

Headers

NameTypeDescription

Authorization*

string

bearer <api token>

{
  "data": {
    "temperature": {
      "t": [1640113400000, 1640113410000, 1640113420000],
      "v": [76.3, 78.2, 79.1],
      // "min": [...], // will be included if includeMin=true
      // "max": [...], // will be included if includeMax = true
      // "aggregatedValues: [...], // may be included for enum tags
    },
    "pressure": {
      "t": [1640113400000, 1640113410000, 1640113420000],
      "v": [29.3, 29.8, 30.1],
      // "min": [...], // will be included if includeMin=true
      // "max": [...], // will be included if includeMax = true
      // "aggregatedValues: [...], // may be included for enum tags
    }
  }
}

Last updated