Skip to content

Tracker events

Contains list method to get tracker's events.


API actions

API path: /history/tracker/.

list

List less than or equal to limit of tracker events filtered by event types (events) between from date/time and to date/time sorted by time field.

parameters

name description type
trackers List of tracker's ids. int array
from Start date/time for searching. string date/time
to End date/time for searching. Must be after "from" date. string date/time
events Optional. Default: all. List of history types. string array
limit Optional. Default: history.maxLimit. Max count of entries in result. int
ascending Optional. Default: true. Sort ascending by time when it is true and descending when false. boolean

If events (event types) not passed then list all event types.

Available event types can be obtained by /history/type/list action.

Default and max limit is 1000. (Note for StandAlone: this value configured by maxHistoryLimit config option).

example

curl -X POST 'https://api.navixy.com/v2/history/tracker/list' \
    -H 'Content-Type: application/json' \ 
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "trackers": [131312, 123985], "from": "2020-12-10 16:44:00", "to": "2020-12-22 16:44:00"}'

response

{
    "success": true,
    "list": [{
         "id": 1,
         "type": "tracker",
         "is_read": false,
         "message": "Alarm",
         "time": "2020-01-01 00:00:00",
         "event": "offline",
         "tracker_id": 2,
         "rule_id": 3,
         "track_id": 4,
         "location":{ 
             "lat": 50.0,
             "lng": 60.0,
             "precision": 50
         },
         "address": "address",
         "extra": {
             "task_id": null ,
             "parent_task_id": null,
             "counter_id": null,
             "service_task_id": null,
             "checkin_id": null,
             "place_ids": null,
             "last_known_location": false,
             "tracker_label": "Tracker label",
             "emergency": false
         }
    }],
    "limit_exceeded": false
}
  • list - list of zero or more history_entry` objects which described in Tracker history entry.
  • limit_exceeded - boolean. false when listed all history entries satisfied with conditions and true otherwise.

errors

  • 211 – Requested time span is too big - time span between from and to is more than report.maxTimeSpan days.
  • 212 – Requested limit is too big - limit is more than history.maxLimit.
  • 217 – List contains nonexistent entities – if one of the specified trackers does not exist or is blocked.

Last update: July 22, 2021