For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tracker events

The event history of one or more trackers over a period.

This operation reads the event history of trackers: everything the Navixy platform recorded about the named devices over a period, including the events its rules raised.

A request with an empty body reports interval as the missing parameter. There is no such parameter. It is the internal name of the field holding both dates, and the public parameters are from and to.

API actions

API base path: /history/tracker.


List tracker history

post
/history/tracker/list

Return the event history of one or more trackers over a period.

A request with an empty body reports interval as the missing parameter. That is the internal name of the field holding both dates; the public parameters are from and to.

Authorizations
AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.

Body
trackersinteger[]Optional

IDs of the trackers to return history for. All must belong to the authorized user and must not be blocked.

fromstringRequired

Start of the period. Include events recorded at or after this date.

Example: 2026-08-24 09:00:00
tostringRequired

End of the period. Include events recorded at or before this date. Must be after from.

Example: 2026-08-24 09:00:00
eventsstring[]Optional

Optional. Restrict to these event types. Available types come from history/type/list.

limitintegerOptional

Optional. Defaults to the platform history.max_limit, which dealer/get_ui_config reports. Maximum number of records to return.

ascendingbooleanOptional

Optional. Default true. Order by time ascending, or descending when false.

only_emergencybooleanOptional

Optional. Default false. Include only emergency events.

only_unreadbooleanOptional

Optional. Default false. Include only unread events.

add_tracker_labelbooleanOptional

Optional. Default true. Add the tracker label to the message field.

add_tracker_filesbooleanOptional

Optional. Default false. Include tracker file information. Honoured only for a caller holding the video_monitoring right, and ignored otherwise.

Responses
200

Matching history entries

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
limit_exceededbooleanOptional

true when the result was cut short by the platform limit, so more entries match than were returned. There is no total count: use the matching count operation for that.

post/history/tracker/list
POST /v2/history/tracker/list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 208

{
  "trackers": [
    1
  ],
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00",
  "events": [
    "text"
  ],
  "limit": 1,
  "ascending": true,
  "only_emergency": true,
  "only_unread": true,
  "add_tracker_label": true,
  "add_tracker_files": true
}
{
  "success": true,
  "list": [
    {
      "id": 1,
      "type": "socket",
      "is_read": true,
      "message": "text",
      "time": "text",
      "event": "text",
      "tracker_id": 1,
      "rule_id": null,
      "track_id": 1,
      "address": null,
      "location": {
        "lat": 1,
        "lng": 1,
        "precision": 1,
        "address": "text"
      },
      "assets": [
        {
          "id": 1,
          "type": "vehicle"
        }
      ],
      "extra": {
        "employee_full_name": "text",
        "vehicle_label": "text",
        "task_id": null,
        "parent_task_id": null,
        "counter_id": null,
        "service_task_id": null,
        "checkin_id": null,
        "place_ids": [
          1
        ],
        "places_total_count": 1,
        "last_known_location": true,
        "tracker_label": "text",
        "emergency": true,
        "zone_ids": [
          1
        ],
        "zone_labels": [
          "text"
        ],
        "proximity_object_id": 1,
        "employee_id": 1,
        "sensor_id": 1,
        "sensor_name": "text",
        "sensor_calculated_value": "text",
        "full_message": "text",
        "precision": 1,
        "command": {
          "name": "text",
          "param": null,
          "response": {
            "status": null,
            "body": null,
            "error": null,
            "success": null
          }
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "limit_exceeded": true
}

Errors

These errors come in addition to the general error codes:

  • 211 - Requested time span is too big.

  • 212 - Requested period is not available on the current plan.

  • 217 - The list contains non-existent entities.

Last updated

Was this helpful?