Skip to content
  • There are no suggestions because the search field is empty.

Xovis Api Documentation _best_ (DELUXE ⟶)

Understanding the Xovis API: A Guide to Integration and Data Access

The Xovis API ecosystem provides system integrators and developers with the tools to bridge the gap between high-precision 3D sensing hardware and actionable business intelligence. By utilizing these APIs, businesses can extract real-time people-flow data, including live occupancy, queue metrics, and demographic insights, to power customized analytics platforms. API Architecture and Methods

Xovis sensors (PC-Series) and the Xovis SPIDER processing unit offer two primary methods for data integration:

REST API (Pull Method): The sensors feature a built-in REST API that allows third-party applications to query the device for specific data points on demand. The V5 API utilizes the OpenAPI specification and supports Basic Authentication (Username/Password) for secure access.

Data Push (Push Method): For real-time applications, sensors can be configured to push data automatically via HTTPs, SFTP, or MQTTS. Common push triggers include:

Xovis Events: Telemetry sent immediately when a virtual line is crossed.

Interval Counts: Periodic updates sent at pre-configured intervals to provide total counts or current occupancy levels. Key Data Points and Capabilities

Through the Xovis API, developers can access a wide array of metadata processed directly on the sensor. This "edge processing" ensures that only anonymous coordinates or numerical triggers leave the device, maintaining strict data privacy. Available data points typically include: Full-featuring APIs - Xovis

Authentication

All API requests require an API key passed via the X-API-Key header.

GET /sites
X-API-Key: your_api_key_here

Real-time streaming (patterns)

Scenario B: Business Intelligence Export

A mall operator needs to analyze weekly traffic trends in PowerBI.

Data formats

B. Get Queue Metrics

Retrieves average queue length and wait times for sensors configured with the Queue Analytics feature.

Endpoint: GET /data/queue

Query Parameters:

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

Xovis provides robust interfaces for integrating high-precision 3D people-counting data into third-party software environments. The primary documentation covers their REST API and Data Push (webhook) mechanisms, specifically for sensors running firmware version 5.0 and higher. 🛠️ API Architecture Overview

Xovis sensors act as independent edge devices that process data locally, which can then be retrieved or pushed via several methods:

REST API: Allows for pull-based data retrieval. Users can query specific endpoints for real-time counts, historical data, and device status.

Data Push (Webhooks): Enables the sensor to proactively send data to a remote server at pre-configured intervals or when specific events occur (e.g., a person crossing a counting line).

Multi-Sensor Sync: For large areas, one sensor can be designated as a "Master" to aggregate data from multiple units, presenting a single unified data stream through its API. 📄 Key Documentation Components

Official technical documentation is typically accessible through the Xovis HUB Partner Platform or direct sensor WebUIs. Key areas include: 1. Endpoint Categories

The Sensor V5 API (OpenAPI/Swagger format) includes endpoints for: Counting Data: Real-time and historical line/zone counts.

AI Metadata: Detailed object data from AI extensions like Gender Statistics or Staff Exclusion.

Device Management: Status, firmware updates, and configuration. xovis api documentation

Blob Management: Handling custom icons or storage files on the device. 2. Authentication

Most integrations utilize Basic Authentication (Username/Password).

API requests often require a specific header, such as X-Requested-With: XmlHttpRequest, to handle browser-based interactions without authentication popups. 3. Data Storage & Retention Xovis sensors can store data locally for up to 120 days.

This ensures data integrity even if the network connection to the central server is temporarily lost. 🚀 Integration Use Cases Full-featuring APIs - Xovis

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.

Elias wasn't just counting heads; he was trying to predict the "Ghost Hour." The Integration

"It’s just a RESTful interface," he muttered, scrolling through the Swagger UI . He began by authenticating his session, sending a request to the

endpoint. The sensor blinked green, acknowledging his credentials with a JSON response that felt like a secret handshake. He moved to the

section. His goal was to capture live "X-Y coordinates" of every person in the lobby. He configured the to stream real-time events to his server. Define the Counting Line Dwell Time threshold. Listen for the person_crossed The Ghost in the Stream

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

. Everything reported "Healthy." He looked at the live stream—the room was empty—but the API was sending a flurry of position_update Understanding the Xovis API: A Guide to Integration

packets. A cluster of coordinates was moving in a perfect, synchronized circle in the center of the room. The Discovery He dove deeper into the AI Plug-in

documentation. He realized the sensor’s "Object Classification" wasn't just identifying "Adult" or "Child." Deep in the metadata of the Extended Object Info , he found a custom tag he hadn't noticed before: Entity_Type: Residual

The Xovis wasn't just a 3D sensor; its high-precision stereoscopic vision was catching the thermal echoes of a crowd that had stood in this very spot fifty years ago, back when the building was a grand theater. The Resolution

Elias didn't call security. He opened his IDE and wrote a new script. Using the GET /zones/stats

endpoint, he began to map the movements of the past. He realized the "ghosts" were waiting in line for a show that never started. With a final request to the sensor's configuration, he adjusted the Height Filter

to ignore anything below the floor level. The spectral coordinates vanished from his screen. The lab fell silent.

He closed the documentation, but as he reached for the light switch, a single notification popped up on his phone: Webhook Event: Door_Open (Confidence: 99%) He looked at the door. It was still locked. How would you like to expand this narrative —perhaps by exploring the security implications of the sensor or the technical specifics of the JSON payloads?

Xovis sensors provide a robust designed for system integrators to build custom retail analytics, queue detection, and passenger flow solutions. Core Documentation Resources Official Support Portal : Comprehensive documentation, product manuals, and the Xovis Sensor Explorer tool are available via the Xovis Customer Portal Sensor V5 OpenAPI

: A detailed specification for firmware versions 5.0 and higher is hosted on the Postman API Network

. It covers endpoints, authentication (Basic Auth), and resource folders. Partner HUB

serves as a centralized platform for remote device management, system planning, and technical training. Key API Features & Capabilities Full-featuring APIs - Xovis Authentication All API requests require an API key