Api Documentation |best| - Xovis

| Parameter | Type | Required | Description | | :--- | :--- | :--- | :--- | | sensor_id | string | Yes | Unique identifier of the sensor. | | start_ts | datetime | Yes | Start time. | | `end

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.

Before making requests, you must establish a secure connection with the sensor or the Xovis Hub. https:// /api/v4/ Xovis Hub: https:// /hub/api/v1/ Authentication Methods

: Demands secure, authenticated sessions (such as HTTP Basic Auth or bearer tokens) on all modern firmware variants (v5.0 and newer). X-Push Interface (Push-Based Method) xovis api documentation

Xovis 3D Sensors offer several integration methods to build custom analytics solutions:

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:

Use the sensor's internal memory for historical data to avoid data loss during network outages. 5. Official Resources | Parameter | Type | Required | Description

, and PC3 series) to enable real-time people flow and retail analytics.

GET /api/v1/system/info : Returns sensor firmware version, uptime, and health status. 3. Key Technical Components

The following Python script demonstrates how to programmatically connect to a Xovis sensor, authenticate, extract live count data, and handle potential errors. Before making requests, you must establish a secure

: Sensors can be configured to push data via HTTPS to two distinct types of endpoints:

If you are polling a single sensor directly, avoid intervals faster than every 5 to 10 seconds to prevent overloading the local edge CPU. Conclusion