ezeio2:apiref:syslog

Return data from the system log.

Description

https://api.eze.io/v1/syslog/{serial}/from={datetime}/to={datetime}/[fields]/[interval[,aggregation]]/["raw"]

Parameters

serial The serial number of the ezeio (XYZ987)
from=datetime The beginning of the range. Format per RFC3339.
to=datetime The end of the range. Format per RFC3339.
fields (optional) Comma separated list of fields. Possible fields are 1-90, GPSx, GPSy, GPSz, GPSsignal. If not given, all fields are returned.
interval (optional) Sample interval. Given as a number followed by 'd', 'h' or 'm' for day, hour or minute.
aggregation (optional) Method of aggregation. Only valid if interval is given.
“raw” (optional) Only return values actually stored in database.

If no interval is given, an automatic interval will be calculated based on the size of the range. This is to ensure the amount of data returned is reasonable.

If range >= 365 days, interval will be 1 day.
If range >= 60 days, interval will be 6 hours.
If range >= 7 days, interval will be 1 hour.
For smaller ranges than 7 days, the interval will be 10 minutes.

Under no circumstances will the call return more than 5000 rows of data.

Aggregation modes:

mean : The mean (average) of samples in the interval
mode : The mode (most common value)
median : The middle value of sorted samples in the interval
min : The smallest value
max : The largest value
sum : The sum of all samples in the interval

Example usage

15 day interval using defaults:

https://api.eze.io/v1/syslog/XYZ987/from=2017-03-01/to=2017-03-15

Specifying fields:

https://api.eze.io/v1/syslog/XYS987/from=2018-10-05T06:30:00Z/to=2018-10-06T06:30:00Z/fields=2,4,12,GPSx,GPSy

Hourly max values:

https://api.eze.io/v1/syslog/XYZ987/from=2019-02-01/to=2019-03-01/fields=1,2/interval=1h,max

Return value

JSON formatted data

(below examples have whitespaces added for readability)

Example query:
https://api.eze.io/v1/syslog/baa157/from=2019-02-01/to=2019-03-01/fields=1,2
 
{
  "reqtime":"2019-06-16T22:51:49Z",
  "fieldmeta":[
    {
      "no":"1",
      "name":"Uptime",
      "tag":"",
      "decimals":"0",
      "unit":"s"
    },
    {
      "no":"2",
      "name":"Temperature",
      "tag":"temp",
      "decimals":"1",
      "unit":"°C"
    }
  ]
  "data":[
    {
      "time":"2019-02-01T00:00:00Z",
      "f1":null,
      "f2":null
    },
    {
      "time":"2019-02-01T00:10:00Z",
      "f1":432609,
      "f2":25.67
    },
    {
      "time":"2019-02-01T00:20:00Z",
      "f1":433209,
      "f2":25.709999
    },
    {
      "time":"2019-02-01T00:30:00Z",
      "f1":433809,
      "f2":25.709999
    },
    // ** Entries removed for brevity **
    {
      "time":"2019-02-28T22:00:00Z",
      "f1":786047.1666666666,
      "f2":25.016666666666666
    },
    {
      "time":"2019-02-28T23:00:00Z",
      "f1":789648,
      "f2":25.151667000000003
    }    
  ],
  "status":"OK",
  "exec_time":0.027250051498413086
}
  • ezeio2/apiref/syslog.txt
  • Last modified: 2019-10-28 20:20
  • by andreh