Api Documentation: Xovis

Ideal for real-time monitoring. The sensor or management software acts as a client, automatically pushing data packets to an external server endpoint via HTTP/HTTPS or MQTT at defined intervals (e.g., every minute or every flight change). 2. Core Endpoints and Data Structures

Do not query the sensor API every time a user refreshes their dashboard. Cache data in a central database (like PostgreSQL or Redis) and query the database instead.

Best for legacy systems requiring scheduled CSV or XML file drops. 2. Authentication and Security xovis api documentation

: The central platform for partners to access technical materials, manuals, and training. Xovis Support Portal

The Xovis platform utilizes a decentralized architecture where the 3D sensors themselves can compute and store data. Depending on your system design, you will interact with the Xovis API in one of two ways: Ideal for real-time monitoring

Explain what fields like objectCount , dwellTime , and queueLength mean in the context of Xovis. Response Codes: Document standard HTTP responses: 200 OK : Request successful. 401 Unauthorized : Authentication failed. 404 Not Found : Endpoint or data range does not exist.

Xovis 3D sensors are the industry standard for people counting, crowd monitoring, and flow analysis in retail, airports, and smart buildings. While the hardware excels at capturing precise spatial data, the true business value lies in your ability to extract, analyze, and act on that data. This is where the Xovis API becomes essential. Core Endpoints and Data Structures Do not query

Do not spam the local sensor REST API with multiple requests per second. For real-time updates, use WebSockets. If using REST, limit polling to once every 30 to 60 seconds.

Get the number of people crossing a predefined virtual line.

Returns the current cumulative inbound and outbound counts for defined counting lines. Sample Response:

A dedicated introduction manual titled "PC-Series API介绍手册" (PC2-API01-EN-V14) is available, which splits the documentation into two parts: Part 1 covering the REST API and Part 2 covering the PUSH API.