Xovis provides robust interfaces for integrating high-precision 3D people-counting data into third-party software environments. The primary documentation covers their REST API and Data Push (webhook) mechanisms, specifically for sensors running firmware version 5.0 and higher. 🛠️ API Architecture Overview
Xovis sensors act as independent edge devices that process data locally, which can then be retrieved or pushed via several methods:
REST API: Allows for pull-based data retrieval. Users can query specific endpoints for real-time counts, historical data, and device status.
Data Push (Webhooks): Enables the sensor to proactively send data to a remote server at pre-configured intervals or when specific events occur (e.g., a person crossing a counting line).
Multi-Sensor Sync: For large areas, one sensor can be designated as a "Master" to aggregate data from multiple units, presenting a single unified data stream through its API. 📄 Key Documentation Components
Official technical documentation is typically accessible through the Xovis HUB Partner Platform or direct sensor WebUIs. Key areas include: 1. Endpoint Categories
The Sensor V5 API (OpenAPI/Swagger format) includes endpoints for: Counting Data: Real-time and historical line/zone counts.
AI Metadata: Detailed object data from AI extensions like Gender Statistics or Staff Exclusion. xovis api documentation
Device Management: Status, firmware updates, and configuration.
Blob Management: Handling custom icons or storage files on the device. 2. Authentication
Most integrations utilize Basic Authentication (Username/Password).
API requests often require a specific header, such as X-Requested-With: XmlHttpRequest, to handle browser-based interactions without authentication popups. 3. Data Storage & Retention Xovis sensors can store data locally for up to 120 days.
This ensures data integrity even if the network connection to the central server is temporarily lost. 🚀 Integration Use Cases Full-featuring APIs - Xovis
Xovis provides comprehensive API documentation primarily through its partner platform and dedicated support portals. Accessing Documentation
The documentation is largely restricted to registered partners and customers. You can access it through the following channels: Inside Xovis API Documentation: A Technical Deep Dive
: The central platform for partners to access technical materials, manuals, and training. Xovis Support Portal
: A Jira-based portal where customers can find product information and documentation. Postman API Network : An unofficial but detailed OpenAPI specification for Xovis Sensor V5 API
is available for public reference, covering basic authentication and endpoint structures. atlassian.net API Features
Xovis 3D Sensors offer several integration methods to build custom analytics solutions:
: Used to control sensor functions and pull pre-processed data. Data Push Options
: Configurable via the sensor's web interface to send real-time telemetry data (like line crossings) in formats to external drivers or platforms. AI Extensions : APIs support managing plugins for advanced features like Staff Exclusion Gender Statistics Object Detection Developer Tools Xovis Sensor Explorer
: A utility for discovering sensors on a local network and configuring IP settings. Firmware Support What’s Well Documented: Payload structure
: Current documentation primarily focuses on sensors with firmware versions 5.0 and higher Full-featuring APIs - Xovis
Since Xovis deals with passenger counting, queue management, and flow analytics, the API focuses heavily on retrieving metrics and understanding sensor status.
In the world of people counting and foot traffic analytics, Xovis is a premium player, known for its high-accuracy 3D stereo vision sensors. While their hardware and PC-based software (Xovis PC Tool) are well-regarded, their API documentation is the critical bridge that turns raw counting data into actionable business intelligence.
This article explores the structure, capabilities, and gaps in the official Xovis API documentation, aimed at system integrators, IT managers, and developers.
Xovis has modernized its API documentation to include MQTT and Webhooks, which are essential for cloud integration.
xovis/sensor/[ID]/count with retained messages. The docs provide a clear payload schema.What’s Well Documented: Payload structure, retry logic (exponential backoff), and security (HMAC signatures for verification).
What’s Missing: No clear guidance on throughput limits (e.g., max webhooks per second per sensor). Developers must guess or test destructively.
| Feature | Xovis API Docs | Brickstream (now Sensormatic) | Traf-Sys | |---------|----------------|-------------------------------|-----------| | REST API | ✅ Detailed | ✅ Good | ❌ Limited | | Real-time streaming | ✅ (Socket/MQTT) | ❌ No | ✅ (WebSocket) | | Sandbox environment | ❌ No | ✅ Yes | ❌ No | | Rate limits documented | ❌ No | ✅ Yes | ❌ No |
Xovis wins on data richness (trajectories, zone occupancy) but loses on developer experience due to missing sandbox and unclear limits.