Include your API key in the header of every request:
X-API-Key: your_api_key_here
Content-Type: application/json
The Xovis API provides programmatic access to the Xovis Passenger Counting and Analytics Platform. It allows third-party applications, BI tools, and management dashboards to retrieve real-time and historical data regarding people counts, queue times, and occupancy levels.
If you want, I can:
To integrate Xovis 3D sensors into your software environment, you can utilize the Xovis REST API or various data push methods to retrieve real-time and historical people flow data. 🚀 Key Integration Methods
Xovis sensors (PC2S, PC3, etc.) offer two primary ways to access data:
REST API: Best for "pulling" specific data on-demand or controlling sensor settings.
Data Push: Best for real-time applications where the sensor "pushes" data to your server via HTTPS, SFTP, or MQTT. 🛠️ API & Endpoint Overview
Most current Xovis sensors run on Firmware V5.0+, which supports the Sensor V5 OpenAPI specification. Common Data Points
You can programmatically retrieve several types of data processed directly on the sensor:
Line Crossings: Total "In" and "Out" counts for specific doors or lines.
Zone Occupancy: Number of people currently in a defined area (e.g., a queue).
AI Extensions: Gender statistics and staff exclusion (requires specific plugins like PIGES or PISTE).
Device Status: System health, uptime, and storage information (sensors can store data for up to 120 days). Authentication
The API typically uses Basic Authentication (Username and Password) configured via the sensor's web interface. 🔧 Setup and Resources Full-featuring APIs - Xovis xovis api documentation
Since Xovis deals with passenger counting, queue management, and flow analytics, the API focuses heavily on retrieving metrics and understanding sensor status.
The documentation lists dozens of endpoints, but 80% of integrations use these three:
| Endpoint | Method | Description |
| :--- | :--- | :--- |
| /sensors | GET | Lists all sensors connected to the XCS. |
| /counts/interval | GET | Retrieves historical footfall data (requires start/end time). |
| /occupancy/current | GET | Snapshot of current load per zone. |
| /queue/status | GET | Data for actively monitored queue areas. |
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 3D sensors utilize a REST API and Data Push capabilities to integrate real-time, AI-powered people counting data with third-party software. The documentation, including technical guides and API endpoints, is primarily accessed through the Xovis HUB partner platform, the Xovis Support Portal, and a community Postman collection. For full access to technical resources, explore the Sensor V5 API | Documentation | Postman API Network
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: Include your API key in the header of
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
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.
Blob Management: Handling custom icons or storage files on the device. 2. Authentication The Xovis API provides programmatic access to the
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
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
The Xovis API documentation provides the technical framework for integrating high-precision people counting and flow analysis data into third-party software environments. Primarily utilized by system integrators in retail, airports, and public transport, the documentation covers a range of RESTful API endpoints, data push mechanisms, and hardware-specific configurations for sensors like the PC-Series and SPIDER. Key Components of the Xovis API
The API architecture is designed to handle various data types, from simple entry/exit counts to complex AI-driven metrics like gender statistics and view direction.
REST API Support: Sensors feature a REST API that allows for direct control of sensor functions and the retrieval of processed retail or transportation analytics.
Sensor V5 Documentation: Recent sensors running firmware 5.0 and higher utilize an updated Sensor V5 API, which is documented via Postman and supports Basic Authentication.
Data Push Options: Instead of manual polling, sensors can be configured to "push" data to a specific URL. For firmware 5+, this is managed through Xovis Logics, which separates data delivery into "Connections" (destination server) and "Agents" (data format/type).
Real-time Protocols: Newest firmware versions support real-time data delivery via MQTT, supplementing standard historical data pushes. Data Integration & Use Cases
Documentation outlines how to extract specific Key Performance Indicators (KPIs) for different industries: Sensor V5 API | Documentation | Postman API Network