Xovis Api Documentation Verified -

RESTful API

The Xovis API documentation provides the technical framework for integrating high-precision people counting and flow analysis data into third-party software environments. Primarily utilized by system integrators in retail, airports, and public transport, the documentation covers a range of endpoints, data push mechanisms, and hardware-specific configurations for sensors like the PC-Series and SPIDER. Key Components of the Xovis API

Step 2: Handle the Response Object

AI Plugin Control

: The API enables the management of specialized AI plugins, such as Gender Statistics (PIGES) and Staff Exclusion (PISTE) , allowing for more granular data filtering and analysis. xovis api documentation

GET

| 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. | RESTful API The Xovis API documentation provides the

• Live Counts: Fetch the current "In/Out" counters from specific devices for real-time display boards.
• Device Status: Check the connectivity state (Online/Offline) and health of sensors.

"status": "error", "code": "INVALID_TIMESTAMP", "message": "start_time must be before end_time" Live Counts: Fetch the current "In/Out" counters from

REST API:

Best for "pulling" specific data on-demand or controlling sensor settings.

AI Extensions:

Gender statistics and staff exclusion (requires specific plugins like PIGES or PISTE ).

UTC

The Xovis API documentation explicitly states that all timestamps are . If your application runs in EST or PST, you must convert. Ignoring this leads to historical reports that look "shifted by 5 hours."