Communicates with a centralized management software instance (Xovis Spider) or the Xovis Cloud. This aggregates data from hundreds of sensors across multiple physical locations into a unified interface. Protocols and Formats
The Xovis API documentation provides the technical framework for integrating high-precision people counting and flow analysis data into third-party software environments. Primarily utilized by system integrators in retail, airports, and public transport, the documentation covers a range of endpoints, data push mechanisms, and hardware-specific configurations for sensors like the PC-Series and SPIDER. Key Components of the Xovis API
Regularly query the system status endpoint to trigger alerts if a sensor goes offline or experiences a camera blockage. To help tailor this guide further, let me know:
If you already have access to Xovis equipment and need a specific endpoint or data format (e.g., real-time WebSocket streams, occupancy, dwell time), let me know — I can help draft further example calls. xovis api documentation
The API allows you to pull this processed data (coordinates, counts, and heatmaps) via:
For real-time queries and direct sensor control, Xovis sensors feature a . This API is designed to give system integrators precise control over the sensor's functions, enabling customized analytics solutions.
<CountData> <Line id="0" name="Entrance"> <Direction type="Forward" value="5"/> <Direction type="Backward" value="1"/> </Line> </CountData> The API allows you to pull this processed
Providing non-personal visual indications of demographics (statistical, not individual). Integration Pathways: REST API vs. Data Push
Element IDs and names (lines and zones) rarely change. Cache these configurations locally instead of querying the setup endpoints with every data request. Only query data endpoints ( /counts ) dynamically.
For real-time operational platforms, Xovis hardware can be configured to act as an active client. The sensor packages metrics internally and pushes them directly to external endpoints like an IoT gateway or a cloud server at custom intervals. retry logic (exponential backoff)
Payload structure, retry logic (exponential backoff), and security (HMAC signatures for verification).
By integrating Xovis data with POS systems, retailers gain a powerful understanding of (how many visitors become customers). This allows for data-driven decisions on store layout, staffing, and promotional effectiveness.