The documentation assumes users already have an Xovis Access Point (XAP) or cloud instance running. It provides no "sandbox" or mock server for testing before hardware arrives.
The Xovis API provides programmatic access to the Xovis Passenger Counting and Analytics Platform. It allows third-party applications, BI tools, and management dashboards to retrieve real-time and historical data regarding people counts, queue times, and occupancy levels.
This guide explores the capabilities, structure, and best practices outlined in the Xovis API documentation to help developers and system integrators build advanced analytical platforms. What is the Xovis API? xovis api documentation
"elementId": "Entrance_Line_1", "elementType": "LINE", "interval": 60, "values": [ "timestamp": "2026-05-28T07:00:00Z", "countForward": 14, "countReverse": 3 , "timestamp": "2026-05-28T07:01:00Z", "countForward": 19, "countReverse": 5 ] Use code with caution. 4. Best Practices for Developers
As mentioned in the opening note, search results can sometimes be confused. The SEO tool "XOVI" has its own API, which is well-documented at developers.xovi.net . This is a completely different service unrelated to people counting. An example of this confusion can be seen in search results for "Xovis::SensorAPI", which returns documentation for the Crystal programming language, not the official Xovis REST API. The documentation assumes users already have an Xovis
: Detailed object data from AI extensions like Gender Statistics or Staff Exclusion .
Through the Xovis API, developers can access a wide array of metadata processed directly on the sensor. This "edge processing" ensures that only anonymous coordinates or numerical triggers leave the device, maintaining strict data privacy. Available data points typically include: Full-featuring APIs - Xovis It allows third-party applications, BI tools, and management
The sensor can be configured to send JSON packets to your server whenever a new event occurs. This is ideal for: Real-time dashboard updates. Immediate integration with POS systems. Reducing latency in data analytics. Key Use Cases Addressed by Xovis API
"sensor_id": "SNSR_001", "location_id": "LOC_NYC_05", "data": [
: Triggered instantly when a line is crossed (e.g., entrance/exit).