Xovis Api: Documentation

For on-premises installations, the Xovis PC Tool offers a local API. The documentation here is noticeably different—more technical, less user-friendly.

Key Features Documented:

Documentation Critique: This section of the docs is dense and aimed at C++ or embedded developers. Examples are scarce. Many users complain that error handling (e.g., what happens when the socket drops) is poorly explained. xovis api documentation

The Xovis API provides a RESTful interface to interact with Xovis 3D Sensors and the Xovis Data Platform (XDP). It allows third-party applications to retrieve real-time people counting data, historical analytics, and sensor status information. The API is designed for building custom dashboards, integrating with BI tools (PowerBI, Tableau), and feeding data into facility management systems.

Requesting 2 years of 1-minute interval data will time out. The documentation recommends pagination parameters (limit and offset) for large historical exports. For on-premises installations, the Xovis PC Tool offers

Best Practice Snippet: GET /counts/interval?start=2023-01-01&end=2023-12-31&interval=PT1H&limit=1000&offset=0


  • Server-Sent Events (SSE): GET https://host/api/v1/stream/events

  • Beyond simple counting, the Xovis API documentation details advanced telemetry that separates this system from basic infrared beam counters. Documentation Critique: This section of the docs is

    Let’s simulate a real-world use case: Displaying real-time store occupancy on a digital sign.