: Current documentation primarily focuses on sensors with firmware versions 5.0 and higher Full-featuring APIs - Xovis
The official documentation is typically distributed via the or installed locally alongside the XCS software. As a security measure, Xovis often requires an active support agreement to access the latest version.
To accurately interpret the JSON payload from the API documentation, you must understand the three primary data tracking elements: xovis api documentation
Webhooks / Event subscriptions
| Parameter | Type | Required | Description | | :--- | :--- | :--- | :--- | | sensor_id | string | Yes | The unique identifier of the sensor. | | zone_id | integer | No | Specific zone ID. If omitted, returns data for all zones. | | start_ts | datetime | Yes | Start time (ISO 8601 format, e.g., 2023-10-27T00:00:00Z ). | | end_ts | datetime | Yes | End time (ISO 8601 format). | | granularity | string | No | Aggregation level ( 1h , 1d ). Default is 1h . | : Current documentation primarily focuses on sensors with
A typical REST endpoint might return an array of sensor details, where a mac_address or zone_id can be used to identify a specific device or location.
The is functional and covers most enterprise use cases—especially for retrieving counts and occupancy. However, it suffers from fragmentation across hardware versions, vague performance limits, and a lack of a testing sandbox. | | zone_id | integer | No | Specific zone ID
The documentation is largely restricted to registered partners and customers. You can access it through the following channels:
Retrieves historical dwell times and fill levels for specified zones. 4. Advanced Features: Dwell Time and Heatmaps