Xovis: Api Documentation
This interface is used for on-demand data retrieval and device management. It allows you to query specific sensor functions, such as current counting values or device status, directly through standard HTTP requests.
Retrieves people counting data (In, Out, Passby) for a specific sensor or zone.
Instead of lines, zones monitor defined geometric areas. The API delivers real-time information regarding: xovis api documentation
This public link is valid for 7 days and shares a thread, including any personal information you added. This link or copies made by others cannot be deleted. If you share with third parties, their policies apply. Can’t copy the link right now. Try again later.
Polling an API every minute is inefficient. The Xovis documentation describes webhooks. You configure XCS to send an HTTP POST to your server only when an event occurs (e.g., queue exceeds 10 people or occupancy hits 90%). This interface is used for on-demand data retrieval
| Parameter | Type | Required | Description | | :--- | :--- | :--- | :--- | | sensor_id | string | Yes | The unique identifier of the sensor. | | zone_id | integer | No | Specific zone ID. If omitted, returns data for all zones. | | start_ts | datetime | Yes | Start time (ISO 8601 format, e.g., 2023-10-27T00:00:00Z ). | | end_ts | datetime | Yes | End time (ISO 8601 format). | | granularity | string | No | Aggregation level ( 1h , 1d ). Default is 1h . |
Real-time count (polling)
Xovis does not host its documentation on a public GitHub repository due to the proprietary nature of the software. To access the official, version-controlled documentation, you must:
Don't overload the sensor. For "Live" data, once every 5–10 seconds is usually sufficient. Instead of lines, zones monitor defined geometric areas
def get_current_occupancy(): try: response = requests.get( f"XOVIS_URL/occupancy/current", headers=headers, timeout=5 ) response.raise_for_status() data = response.json()
The Xovis API is an interface that allows software developers and system integrators to access the data collected by Xovis's 3D stereoscopic vision sensors. Renowned for their exceptional accuracy of up to 98%, these sensors count people, track movement, and analyze waiting times without using personally identifiable information (PII). The API serves as a bridge, enabling this valuable data to be pulled directly into third-party business intelligence tools, customer dashboards, queue management systems, or POS analytics platforms.
