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

Mileage

How far a tracker travelled over a period, in kilometres, grouped by tracker and day.

Mileage is the distance a tracker covered over a period, returned in kilometres and broken down by tracker and then by day.

Date and time values follow the platform formats.

API actions

API base path: /tracker/stats/mileage.


Read mileage per day

post
/tracker/stats/mileage/read

Get mileage in kilometres for a period, grouped by tracker and then by day. Available to demo accounts.

A day with no data comes back as null, not as zero. That distinction matters: null means nothing was recorded, while {"mileage": 0.0} means the device was tracked and did not move.

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[] · max: 128Required

Tracker IDs. At most 128 per request.

Example: [123456]
fromstringRequired

Start of the period, YYYY-MM-DD HH:MM:SS, in the account timezone.

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

End of the period. Must be after from.

Example: 2026-08-24 09:00:00
Responses
200

The mileage

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
limit_exceededbooleanOptional

true when the period was clipped because it exceeded what the plan covers.

post/tracker/stats/mileage/read
POST /v2/tracker/stats/mileage/read HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "trackers": [
    123456
  ],
  "from": "2026-08-24 09:00:00",
  "to": "2026-08-24 09:00:00"
}
{
  "success": true,
  "result": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": {
        "mileage": 199.09
      }
    }
  },
  "limit_exceeded": true
}

Errors

These errors come in addition to the general error codes:

  • 211 - The period is longer than the Navixy platform allows.

  • 217 - The list names trackers that do not exist.

  • 221 - The device limit of the telematics service provider (TSP) is exceeded.

Last updated

Was this helpful?