Xovis operates on an edge-computing architecture. This means the 3D stereoscopic sensors process video streams locally on the device itself, calculating counts, dwell times, and fill levels without sending video feeds to the cloud. This design ensures strict data privacy and compliance with GDPR regulations.
This article explores the structure, capabilities, and gaps in the official Xovis API documentation, aimed at system integrators, IT managers, and developers.
| Endpoint | Method | Description | | :--- | :--- | :--- | | /sensors | GET | Lists all sensors connected to the XCS. | | /counts/interval | GET | Retrieves historical footfall data (requires start/end time). | | /occupancy/current | GET | Snapshot of current load per zone. | | /queue/status | GET | Data for actively monitored queue areas. |
The Data Push mechanism is designed for real-time automation. Instead of polling the sensor for updates, the sensor automatically sends data to a remote destination when an event occurs. This is a asynchronous model. The data is delivered via HTTP(S), FTP, or SFTP/SSH. xovis api documentation
For applications like live digital signage (e.g., displaying "Store is Full" signs) or dynamic HVAC control, pulling data via polling HTTP requests introduces lag. Instead, use the Xovis feature described in the advanced documentation.
The Xovis API uses to authenticate requests. You can manage your API keys within the Xovis Cloud Dashboard under Settings > Integrations .
Zones track how many people are currently inside a specific geometric area and how long they stay there. This is vital for queue management and hotspot analysis. GET Endpoint: /api/v4/elements/zones/occupancy Sample JSON Response: Xovis operates on an edge-computing architecture
Let’s simulate a real-world use case: Displaying real-time store occupancy on a digital sign.
Whether you are connecting directly to or using Xovis Spider / Cloud .
The Xovis API documentation explicitly states that all timestamps are . If your application runs in EST or PST, you must convert. Ignoring this leads to historical reports that look "shifted by 5 hours." This article explores the structure, capabilities, and gaps
In smart buildings, API data triggers automation rules. If the API reports "Zone Occupancy" is below a threshold, the system sends an MQTT command to the HVAC system to reduce air conditioning in that area, saving energy. If occupancy is high, it triggers a cleaning alert for facility management.
Response: