Fuel sensor quality index

Contains API calls to interact with fuel sensor quality index.

Resource

Resource path: /trackers/$tracker_id/sensors/$sensor_id/quality, on the /eco_fleet/v1 base path.

Returns the fuel sensor quality index calculated from sensor readings within a specified datetime period.

smoothness is a score of the sensor readings. Higher values indicate reduced noise in sensor readings, while lower values suggest increased noise. It is a Score, an abstract measurement from 1.0 to 10.0 inclusive.

Note that a successful response is a bare JSON object, with no success field, and that errors follow RFC 7807 problem details rather than the numeric status.code the Platform API uses.

Get fuel sensor quality index

get

/trackers/{tracker_id}/sensors/{sensor_id}/quality

Return a quality index for a fuel sensor, calculated from its readings over the given period.

A higher smoothness means less noise in the readings; a lower value means more noise.

Authorizations

AuthorizationstringRequired

Either a user session hash or an API key, with the "NVX " prefix, for example "NVX 22eac1c27af4be7b9d04da2ce1af111b". The same credential the Platform API uses.

Path parameters

tracker_idintegerRequired

ID of the tracker which has the sensor.

Example: 123

sensor_idintegerRequired

ID of the sensor to analyze.

Example: 321

Query parameters

intervalstringOptional

Sensor readings' datetime interval to analyse, as an ISO 8601 interval. Defaults to the last week.

Example: P7D/2020-12-31T00:00Z

Responses

200

The quality index. Note there is no success envelope.

application/json

smoothnessnumber · min: 1 · max: 10Optional

An abstract measurement score, from 1.0 to 10.0 inclusive.

Example: 8.29

400

Bad request. Also returned as type errors/sensors/quality/not-enough-readings when the interval holds too few readings: use a period with more vehicle usage, or increase the sending frequency and wait for data to accumulate.

application/json

401

No credential supplied. Type errors/default/unauthorized.

application/json

404

Sensor or calibration table is missing. Type errors/entity/not-found.

application/json

502

The Navixy Platform API could not be reached, or returned an error. Type errors/external-api/navixy, with the underlying code and message in detail.

application/json

default

Error response, following RFC 7807 problem details. Note this is not the Platform API error shape: there is no success field and no numeric status.code.

application/json

get/trackers/{tracker_id}/sensors/{sensor_id}/quality

GET /eco_fleet/v1/trackers/{tracker_id}/sensors/{sensor_id}/quality HTTP/1.1
Host: api.eu.navixy.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "smoothness": 8.29
}

Errors

This API reports errors as RFC 7807 problem-detail strings, so the general error codes do not apply to it:

• errors/entity/not-found - Entity not found. Thrown if sensor or calibration table is missing.

• errors/external-api/navixy - Error accessing Navixy API. See detail field and consult Backend API documentation.

• errors/sensors/quality/not-enough-readings - Not enough sensor readings in given interval. Try using interval with enough vehicle usage or changing readings' sending frequency and waiting for data accumulation.

• errors/default/unauthorized - No credential supplied.