Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision |
ezeio2:apiref:syslog [2019-10-28 20:14] – andreh | ezeio2:apiref:syslog [2021-08-24 20:29] – andreh |
---|
=== Description === | === 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> |
| |
| |
| |
| ''serial'' | The serial number of the ezeio (XYZ987) | | | ''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. | | | ''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. | | | ''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. | | | ''aggregation'' (optional) | Method of aggregation. Only valid if interval is given. | |
| ''"raw"'' (optional) | Only return values actually stored in database. | | | ''"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. | 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 >= 7 days, interval will be 1 hour.\\ | If range >= 7 days, interval will be 1 hour.\\ |
For smaller ranges than 7 days, the interval will be 10 minutes. | 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: | Aggregation modes: |