> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/eco-fleet-api/sensors.md). # 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 > 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. ```json {"openapi":"3.1.0","info":{"title":"Navixy Eco Fleet API","version":"0.1.0"},"tags":[{"name":"Eco Fleet","description":"Resampling fuel and movement data onto a uniform time grid, and scoring how noisy a fuel sensor's readings are."}],"servers":[{"url":"https://api.eu.navixy.com/eco_fleet/v1","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/eco_fleet/v1","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/eco_fleet/v1","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". The same credential the Platform API uses.","name":"Authorization","in":"header"}},"schemas":{"Score":{"type":"number","description":"An abstract measurement score, from 1.0 to 10.0 inclusive.","minimum":1,"maximum":10}},"responses":{"Problem":{"description":"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`.","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Error type identifier, for example `errors/entity/not-found`, `errors/external-api/navixy`, `errors/sensors/quality/not-enough-readings`, or `errors/default/unauthorized`. `about:blank` for generic HTTP errors."},"title":{"type":"string","description":"Short human-readable summary."},"status":{"type":"integer","description":"HTTP status code, repeated in the body."},"detail":{"type":"string","description":"What went wrong. For `errors/external-api/navixy` this carries the underlying Platform API code and message."},"instance":{"type":"string","description":"Path of the request that failed, relative to the base path."}}}}}}}},"paths":{"/trackers/{tracker_id}/sensors/{sensor_id}/quality":{"get":{"tags":["Eco Fleet"],"summary":"Get fuel sensor quality index","description":"Return a quality index for a fuel sensor, calculated from its readings over the given period.\n\nA higher `smoothness` means less noise in the readings; a lower value means more noise.","operationId":"ecoFleetTrackerSensorQuality","parameters":[{"name":"tracker_id","in":"path","required":true,"description":"ID of the tracker which has the sensor.","schema":{"type":"integer"}},{"name":"sensor_id","in":"path","required":true,"description":"ID of the sensor to analyze.","schema":{"type":"integer"}},{"name":"interval","in":"query","required":false,"description":"Sensor readings' datetime interval to analyse, as an ISO 8601 interval. Defaults to the last week.","schema":{"type":"string"}}],"responses":{"200":{"description":"The quality index. Note there is no `success` envelope.","content":{"application/json":{"schema":{"type":"object","properties":{"smoothness":{"$ref":"#/components/schemas/Score"}}}}}},"400":{"description":"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.","$ref":"#/components/responses/Problem"},"401":{"description":"No credential supplied. Type `errors/default/unauthorized`.","$ref":"#/components/responses/Problem"},"404":{"description":"Sensor or calibration table is missing. Type `errors/entity/not-found`.","$ref":"#/components/responses/Problem"},"502":{"description":"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`.","$ref":"#/components/responses/Problem"},"default":{"$ref":"#/components/responses/Problem"}}}}}} ``` #### Errors This API reports errors as RFC 7807 problem-detail strings, so the [general error codes](/docs/navixy-api/general/errors.md#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](/docs/navixy-api/general/errors.md). * `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. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/eco-fleet-api/sensors.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.