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

Sensor readings

The last value of every sensor, state field and counter on a tracker, in one call.

These two operations return the last value of everything a tracker measures: metering sensors, discrete inputs, state fields, virtual sensors, and counters, together in one response.

This is the broadest of the reading calls. Where get_fuel, get_readings, and get_diagnostics each cover one slice, readings/list covers all of them at once and adds virtual sensors and counters on top. Filtering by sensor_type narrows it to matching sensors and drops the state values and counters entirely.

Sensor types are listed under metering sensor types and virtual sensor types. For a worked example, see how to retrieve sensor and counter data.

Readings batch object

The result object of readings/batch_list maps each tracker ID to one readings object:

API actions

API base path: /tracker/readings.


Read all sensor values

post
/tracker/readings/list

Get the last value of every sensor, state field and counter on a tracker. This is the broadest of the reading calls: unlike get_fuel, get_readings and get_diagnostics, it covers CAN, OBD and fuel together and adds virtual sensors and counters. Reachable from a geo link session.

Filtering by sensor_type drops the state values and counters from the response, leaving only matching sensors.

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: 999199
sensor_typestringOptional

Optional. Return only sensors of this metering or virtual type. Supplying it also omits states and counters.

Example: fuel
include_componentsbooleanOptional

Optional. Default true. Set false to leave out the parts that make up composite sensors.

Responses
200

The readings

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

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

{
  "tracker_id": 999199,
  "sensor_type": "fuel",
  "include_components": true
}
{
  "success": true,
  "inputs": [
    {
      "sensor_id": 37641,
      "value": 5.66,
      "label": "Tank 1",
      "units": "litres",
      "name": "fuel_level",
      "type": "fuel",
      "units_type": "litre",
      "update_time": "text",
      "min_value": 1,
      "max_value": 1,
      "converted_units_type": null,
      "converted_value": null,
      "composite_sensor_ids": [
        1
      ]
    }
  ],
  "states": [
    {
      "field": "obd_mil_status",
      "value": null,
      "update_time": "text"
    }
  ],
  "virtual_sensors": [
    {
      "sensor_id": 37643,
      "label": "Virtual Ignition",
      "value": "On",
      "type": "virtual_ignition",
      "update_time": "text"
    }
  ],
  "counters": [
    {
      "type": "odometer",
      "value": 100500.1,
      "update_time": "2014-03-06 13:57:00"
    }
  ]
}

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.


Read all sensor values for several trackers

post
/tracker/readings/batch_list

The many-tracker form of readings/list. Reachable from a geo link session.

A tracker with nothing to report still appears in result, with empty arrays, and keys are absent rather than empty when a whole category has no data.

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[]Required

Tracker IDs.

Example: [999199,991999]
sensor_typestringOptional

Optional. Return only sensors of this metering or virtual type. Supplying it also omits states and counters.

Example: fuel
include_componentsbooleanOptional

Optional. Default true. Set false to leave out the parts that make up composite sensors.

Responses
200

Readings per tracker

application/json
successbooleanRead-onlyOptional

true if request finished successfully.

Example: true
post/tracker/readings/batch_list
POST /v2/tracker/readings/batch_list HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "trackers": [
    999199,
    991999
  ],
  "sensor_type": "fuel",
  "include_components": true
}
{
  "success": true,
  "result": {
    "ANY_ADDITIONAL_PROPERTY": {
      "inputs": [
        {
          "sensor_id": 37641,
          "value": 5.66,
          "label": "Tank 1",
          "units": "litres",
          "name": "fuel_level",
          "type": "fuel",
          "units_type": "litre",
          "update_time": "text",
          "min_value": 1,
          "max_value": 1,
          "converted_units_type": null,
          "converted_value": null,
          "composite_sensor_ids": [
            1
          ]
        }
      ],
      "states": [
        {
          "field": "obd_mil_status",
          "value": null,
          "update_time": "text"
        }
      ],
      "virtual_sensors": [
        {
          "sensor_id": 37643,
          "label": "Virtual Ignition",
          "value": "On",
          "type": "virtual_ignition",
          "update_time": "text"
        }
      ],
      "counters": [
        {
          "type": "odometer",
          "value": 100500.1,
          "update_time": "2014-03-06 13:57:00"
        }
      ]
    }
  }
}

Errors

These errors come in addition to the general error codes:

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

Last updated

Was this helpful?