Documentation | Xovis Api

As the clock struck midnight, the sensor began to fire. The API wasn't returning zeros. It was returning dwell times. "dwell_time": -42 Elias checked the Status API

Security is paramount when exposing IoT devices to a network. Xovis utilizes standard web security protocols to secure API endpoints. Authentication Types

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

Count data tracks the number of people crossing a predefined virtual line (Count Line) or entering a specific zone. xovis api documentation

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

The API documentation specifies that you can set a "Granularity" (e.g., 1 minute, 5 minutes) to decide how the count data is aggregated before sending.

import requests from requests.auth import HTTPBasicAuth import json # Configuration SENSOR_IP = "119.2.0.50" # Replace with your sensor's IP USERNAME = "admin" PASSWORD = "SecurePassword123" url = f"https://SENSOR_IP/api/v4/elements/lines/counts" try: # Making a secure GET request with Basic Auth # Note: In production, verify SSL certificates (verify=True) response = requests.get( url, auth=HTTPBasicAuth(USERNAME, PASSWORD), headers="Accept": "application/json", verify=False ) # Check if request was successful if response.status_code == 200: data = response.json() print("Data retrieved successfully:") print(json.dumps(data, indent=2)) # Example of iterating through line counts for line in data.get("lines", []): print(f"Line: line['elementName'] | In: line['forwardCount'] | Out: line['backwardCount']") else: print(f"Failed to connect. HTTP Status Code: response.status_code") print(response.text) except requests.exceptions.RequestException as e: print(f"An error occurred during communication: e") Use code with caution. 6. Best Practices for Developers As the clock struck midnight, the sensor began to fire

"status": "OK", "uptime": 86400, "firmwareVersion": "4.x.x", "temperatureCelsius": 42.5 Use code with caution. B. Real-Time Count Data (Live Data)

The fluorescent lights of the retail analytics lab hummed at a frequency that matched Elias’s mounting tension. Before him sat the "Xovis PC2S" sensor—a sleek, white eye mounted to the ceiling—and on his monitor, the Xovis API Documentation glowed like a digital grimoire.

: All image processing occurs on the sensor itself; only anonymous coordinates or count data are pushed out, ensuring privacy compliance. Key API Endpoints and Formats "dwell_time": -42 Elias checked the Status API Security

Developers working with the Xovis ecosystem can consume and transmit data using two primary communication architectural styles: 1. The Pull Mechanism: REST API

Ensuring sensors are synchronized for accurate tracking. 2. People Counting & Tracking Data (v5)