Xovis Api Documentation Jun 2026

: The documentation specifies support for HTTP(S), FTP, and SFTP/SSH . Validation recordings, used for verifying count accuracy, typically use FTP or SFTP only.

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.

Xovis provides two primary methods for integrating data, depending on your system architecture. REST API (Pull Model)

It allows for the integration of live data for immediate action. xovis api documentation

Based on driver documentation, standard implementation methods include:

Xovis documentation takes security seriously but makes it cumbersome.

Used primarily for local sensor REST APIs, requiring a base64-encoded username and password string in the HTTP header. : The documentation specifies support for HTTP(S), FTP,

: Allows for pull-based data retrieval. Users can query specific endpoints for real-time counts, historical data, and device status.

Before making your first API call, you must authenticate your requests. Xovis secures its endpoints using standard web security protocols.

| Object | Fields | Use Case | |--------|--------|----------| | | timestamp , direction (enter/exit), count , sensorId | Door counting | | Occupancy | zoneId , peopleCurrent , maxCapacity , timestamp | Restroom or queue management | | Trajectory | path (array of x,y points), duration , startZone , endZone | Heatmaps and path analysis | For real-time updates, use WebSockets

To get the current fill level of a specific zone or the count data from a designated "line" (doorway), you send a GET request to the data endpoint. /api/v4/elements/counts Method: GET Sample JSON Response:

When building production-ready applications with the Xovis API, keep the following development principles in mind:

As mentioned in the opening note, search results can sometimes be confused. The SEO tool "XOVI" has its own API, which is well-documented at developers.xovi.net . This is a completely different service unrelated to people counting. An example of this confusion can be seen in search results for "Xovis::SensorAPI", which returns documentation for the Crystal programming language, not the official Xovis REST API.