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.
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.
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.
Tracker IDs. At most 128 per request.
[123456]Start of the period, YYYY-MM-DD HH:MM:SS, in the account timezone.
2026-08-24 09:00:00End of the period. Must be after from.
2026-08-24 09:00:00The mileage
true if request finished successfully.
truetrue when the period was clipped because it exceeded what the plan covers.
Bad request. The response body carries the API-level error code in status.code. Validation failures also include an errors array naming each offending parameter.
Error 211: the period is longer than the platform allows. Error 217: the list names trackers that do not exist. Error 221: the device limit of the TSP is exceeded.
Error response object
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?