Xovis Api Documentation _top_ Jun 2026
This is the most common data type. The sensor tracks when a person crosses a virtual "Count Line" or enters a "Zone."
GET /api/v1/data/history : Fetch count data for a specific time range (requires from and until parameters).
GET /sites X-API-Key: your_api_key_here
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.
Relying solely on HTTP GET requests (pulling) can create unnecessary network overhead if you need real-time data. Xovis supports event-driven architectures through . MQTT Integration xovis api documentation
Your server application must parse this JSON and store or process the direction and gender data accordingly.
When a person crosses the defined line, the sensor pushes a payload to your URL. A typical LineCrossing event looks like this:
A typical REST endpoint might return an array of sensor details, where a mac_address or zone_id can be used to identify a specific device or location.
If you configure a push for using XML, a snippet might look like this: This is the most common data type
While specific endpoints vary by firmware version, the standard structure follows these patterns:
: To configure a new data push agent, you must:
Trajectory data is only available via the real-time socket API, not the REST API, which is a notable limitation mentioned but not justified in the docs.
To pull live data, a developer sends an HTTP GET request to the designated data endpoint. While the hardware excels at capturing precise spatial
Below is a practical Python script demonstrating how to pull counting data from a Xovis sensor, handle authentication, and parse the JSON payload safely.
Defined polygonal areas used to measure dwell time, queue lengths, and instantaneous occupancy.
Get the number of people crossing a predefined virtual line.
The primary function of the API is to fetch processed metrics rather than raw video streams.
: Triggered instantly when a line is crossed (e.g., entrance/exit).
