Xovis Api Documentation Patched Jun 2026

curl -H "Authorization: Bearer YOUR_TOKEN" \ "https://<xovis-host>/api/devices"

The Xovis REST API allows external systems to request data on demand. Your server sends an HTTP request to the sensor (or a centralized Xovis spider/management server), and the sensor responds with the requested data payload. The Push Method: Data Forwarding

: Most sensor-level APIs, including the Sensor V5 API , use standard Basic Auth (Username and Password).

GET /data/queue

"status": "error", "code": "INVALID_TIMESTAMP", "message": "start_time must be before end_time" xovis api documentation

Xovis sensors use virtual "count lines" to track objects crossing a specific threshold.

import requests from requests.auth import HTTPBasicAuth import json # Configuration variables SENSOR_IP = "192.168.1.50" USERNAME = "admin" PASSWORD = "your_secure_password" ENDPOINT = f"https://SENSOR_IP/api/v4/elements/counts" def fetch_xovis_data(): try: # Making a secure GET request to the Xovis sensor response = requests.get( ENDPOINT, auth=HTTPBasicAuth(USERNAME, PASSWORD), verify=True, # Ensure SSL certificates are validated in production timeout=10 ) # Check if response is successful if response.status_code == 200: data = response.json() print("Data successfully retrieved from Xovis Sensor:") print(json.dumps(data, indent=2)) return data elif response.status_code == 401: print("Authentication failed: Invalid username or password.") else: print(f"Failed to fetch data. HTTP Status Code: response.status_code") except requests.exceptions.Timeout: print("Error: The request timed out. Check network connectivity to the sensor.") except requests.exceptions.RequestException as e: print(f"An error occurred during integration: e") if __name__ == "__main__": fetch_xovis_data() Use code with caution. 5. Best Practices for Developers

The Data Push feature is the most commonly used method for getting aggregated data out of a Xovis sensor. It is configured directly in the sensor's WebUI and allows the sensor to act as a client, sending data to a remote server.

The modern Xovis ecosystem relies primarily on a . Unlike legacy systems that required polling hardware registers, Xovis has shifted toward web-standard JSON over HTTPS. Check network connectivity to the sensor

from : Start timestamp (ISO 8601 format, e.g., 2026-05-21T08:00:00Z ) to : End timestamp (ISO 8601 format)

Don't overload the sensor. For "Live" data, once every 5–10 seconds is usually sufficient.

Health & diagnostics

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

: Configured via the sensor's WebUI. These outbound agents push raw metrics or telemetry at specified granularities or event-triggers to your custom cloud backend, IoT platforms, or local endpoints. 🛠️ Key API Functional Modules 1. Line Crossing & Counting (Telemetry)

In the world of people counting and foot traffic analytics, Xovis is a premium player, known for its high-accuracy 3D stereo vision sensors. While their hardware and PC-based software (Xovis PC Tool) are well-regarded, their API documentation is the critical bridge that turns raw counting data into actionable business intelligence.

: 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.