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

Engine hours

How long a tracker's engine ran over a period, counted per day.

Engine hours are the time a tracker's engine spent running over a period.

The count comes from the device's ignition input, so a model without one answers error 214.

Date and time values follow the platform formats.

API actions

API base path: /tracker/stats/engine_hours.


Read engine hours

post
/tracker/stats/engine_hours/read

Get the engine hours counted for a period, meaning the time the engine was on.

The device needs an ignition input; models without one answer error 214.

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
tracker_idintegerRequired

ID of the tracker, also known as the object ID. Must belong to the current account and not be blocked.

Example: 123456
fromstringRequired

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

Example: 2020-09-24 03:24:00
tostringRequired

End of the period. Must be after from.

Example: 2020-09-24 06:24:00
Responses
200

The engine hours

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
valuenumberOptional

Engine hours counted for the period.

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

{
  "tracker_id": 123456,
  "from": "2020-09-24 03:24:00",
  "to": "2020-09-24 06:24:00"
}
{
  "success": true,
  "value": 42
}

Errors

These errors come in addition to the general error codes:

  • 204 - No tracker with this ID belongs to the account.

  • 208 - The tracker exists but is blocked, normally because its tariff ended.

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

  • 214 - The device has no ignition input.

  • 219 - The tracker is a clone.

Last updated

Was this helpful?