Sensors feature a REST API that allows for direct control of sensor functions and the retrieval of processed retail or transportation analytics.
Xovis API documentation covers advanced AI plugins that add layers of intelligence, such as:
reset_count : Remotely clear sensor counts for session-based tracking.
Data regarding people entering or exiting designated areas. xovis api documentation
: Lightweight publish-subscribe topology ideal for IoT platforms like IoT Open .
A physical sensor can monitor multiple "virtual zones." New users often query /sensors expecting occupancy data, but the docs clarify that occupancy belongs to /zones .
A building management system (BMS) needs to adjust air conditioning based on room density. Sensors feature a REST API that allows for
Recent sensors running firmware 5.0 and higher utilize an updated Sensor V5 API , which is documented via Postman and supports Basic Authentication .
xovis/sensor/[SENSOR_ID]/line/[LINE_ID] Webhooks (HTTP Push)
import requests import time
| Code | Description | | :--- | :--- | | 401 Unauthorized | Missing or invalid API key. | | 403 Forbidden | Valid key, but insufficient permissions for the requested resource. | | 429 Too Many Requests | Rate limit exceeded. Please retry after the specified delay. |
To get the current fill level of a specific zone or the count data from a designated "line" (doorway), you send a GET request to the data endpoint. /api/v4/elements/counts Method: GET Sample JSON Response:
Access advanced data such as Gender Statistics , Staff Exclusion , and Object Detection (e.g., bikes, strollers, wheelchairs). Recent sensors running firmware 5
: Integration tools like the Xovis User Guide for Niagara 4 allow for adjustable polling frequencies (Fast, Normal, Slow) to balance data freshness with network overhead. Common API Endpoints & Methods