Differences

This shows you the differences between two versions of the page.

--- ezeio2:apiref:syslog [2019-06-16 22:52] – created andreh
+++ ezeio2:apiref:syslog [2021-08-24 20:31] – andreh
@@ Line 1: / Line 1: @@
-===== API reference ======
 ==== syslog ====
@@ Line 7: / Line 5: @@
 === Description ===
-<code>https://api.eze.io/v1/syslog/{serial}/from={datetime}/to={datetime}/[fields]/[interval[,aggregation]]/["raw"]</code>
+<code>https://api.eze.io/v1/syslog/{serial}/from={datetime}/[to={datetime}]/[fields]/[interval[,aggregation]]/["raw"]</code>
@@ Line 14: / Line 12: @@
 | ''serial'' | The serial number of the ezeio (XYZ987) |
-| ''from=datetime'' | The beginning of the range. Format per RFC3339. |
+| ''from=datetime'' | The beginning of the range. Format per RFC3339 or 1d/1h/1m |
-| ''to=datetime'' | The end of the range. Format per RFC3339. |
+| ''to=datetime'' | The end of the range. Format per RFC3339. If not given, current time is assumed.|
 | ''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. |
+The ''from'' parameter can be given as number of minutes/hours/days relative to current time. For example ''from=17h'' means "17 hours ago".
 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.
@@ Line 27: / Line 27: @@
 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:
@@ Line 55: / Line 57: @@
 <code javascript>
+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":[
     {
@@ Line 78: / Line 100: @@
       "f2":25.709999
     },
-    // ----- Entries removed
+    // ** 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.030946969985961914}
+    },
+    {
+      "time":"2019-02-28T23:00:00Z",
+      "f1":789648,
+      "f2":25.151667000000003
+    }
   ],
   "status":"OK",