Api Documentation: Xovis
Implement retry logic for network timeouts or sensor reboots.
However, for specific tasks like testing with tools such as Postman, an is available. This approach is described in the Xovis::SensorAPI documentation, where the get_token method is an alternative to using basic auth, though it's noted as being primarily for testing. For managing API keys in automated environments, the xovi-sdk (note: different tool) provides an example of using a .env.local file to securely store the API key.
], "totals": "in": 345, "out": 285, "net": 60
For environments like airport security checkpoints or retail checkouts, tracking how long people wait is crucial. /api/v4/elements/queues Method: GET Sample JSON Response: xovis api documentation
Xovis sensors operate as edge computing devices. They process video feeds locally on the chip to ensure data privacy (GDPR compliance) and output structured text data. The Xovis platform offers two primary methods for data retrieval:
What or platform (e.g., Python, Node.js, Power BI) are you building this on?
This is the most common data type. The sensor tracks when a person crosses a virtual "Count Line" or enters a "Zone." Implement retry logic for network timeouts or sensor reboots
Real-time count (polling)
Individual tracked entities. Advanced API levels provide anonymized trajectory data showing exactly how paths move through a physical space. Sample JSON Response (Live Zone Occupancy)
For real-time queries and direct sensor control, Xovis sensors feature a . This API is designed to give system integrators precise control over the sensor's functions, enabling customized analytics solutions. For managing API keys in automated environments, the
When a person crosses the defined line, the sensor pushes a payload to your URL. A typical LineCrossing event looks like this:
Defined polygonal areas used to measure dwell time, queue lengths, and instantaneous occupancy.
Below is a structured "write-up" or guide for someone looking to document or use the Xovis API. 1. Introduction & Authentication
The data you can access through these APIs falls into several core categories:




