For developers and system integrators, the is the key to transforming raw pedestrian data into actionable business intelligence. Whether you are looking to integrate real-time occupancy data into a building management system (BMS), feed footfall metrics into a CRM, or trigger automated alerts in a queue management dashboard, understanding this documentation is critical.
Beyond direct REST requests, Xovis sensors support mechanisms to export telemetry automatically without constant polling. xovis api documentation
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. For developers and system integrators, the is the
: The GitHub repository sdu-cfei/xovis-driver provides an open-source example of a driver designed to receive this pushed data. Its configuration guide, which matches the manual's instructions, suggests settings like: Data Type : Line count data, Interval : 1 minute, Granularity : 1 minute, Protocol : HTTP(S), and Data push format : JSON. The URL would be the endpoint of the receiving service. The documentation assumes users already have an Xovis
| Method | Endpoint Example | Description | | :--- | :--- | :--- | | | /api/v3/count | Retrieves aggregated count data for a specific time range. | | GET | /api/v3/status | Returns the operational status of the sensor. | | GET | /api/v3/zones | Lists all configured counting zones and their IDs. | | GET | /api/v3/occupancy | Returns current occupancy levels for defined zones. |
| 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 . |