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
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
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 xovis api documentation
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
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 3D sensors utilize a REST API for system integration, enabling data streaming, configuration management, and AI-powered analytics for retail and airport applications. Detailed documentation for Sensor V5 API is accessible through the Postman API Network, providing comprehensive information on data structures and authentication protocols. Review the documentation and resources at Xovis.com. Full-featuring APIs - Xovis
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 3D sensors utilize a REST API and
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 comprehensive API documentation primarily through its partner platform and dedicated support portals. Accessing Documentation
The documentation is largely restricted to registered partners and customers. You can access it through the following channels:
: The central platform for partners to access technical materials, manuals, and training. Xovis Support Portal
: A Jira-based portal where customers can find product information and documentation. Postman API Network : An unofficial but detailed OpenAPI specification for Xovis Sensor V5 API
is available for public reference, covering basic authentication and endpoint structures. atlassian.net API Features
Xovis 3D Sensors offer several integration methods to build custom analytics solutions:
: Used to control sensor functions and pull pre-processed data. Data Push Options
: Configurable via the sensor's web interface to send real-time telemetry data (like line crossings) in formats to external drivers or platforms. AI Extensions : APIs support managing plugins for advanced features like Staff Exclusion Gender Statistics Object Detection Developer Tools Xovis Sensor Explorer
: A utility for discovering sensors on a local network and configuring IP settings. Firmware Support
: Current documentation primarily focuses on sensors with firmware versions 5.0 and higher Full-featuring APIs - Xovis Zones Xovis sensors allow the creation of custom
Xovis 3D Sensors provide two primary methods for developers to access people-counting and tracking data: a for on-demand queries and a mechanism for real-time integration. 1. REST API (v5.0 and Higher) The modern API is built on the OpenAPI specification
, allowing for standardized integration using tools like Postman. Authentication Basic Auth Capabilities Retrieve real-time and historical person counts. Manage sensor configurations and plugins (e.g., Gender Recognition or Staff Exclusion).
Access device-specific "Points" and "Logics" configured within the sensor. 2. Data Delivery Methods
Depending on your architecture, you can choose between proactive polling or reactive push: Xenometric REST API (Pull)
: Best for occasional data retrieval or checking sensor status. Data Push (Push)
: The sensor acts as a client, sending data to a specified URL or server (e.g., IMMOTION Cloud or a custom X-Push service
: Supported in firmware version 5+ for low-latency, real-time pedestrian flow reporting. Xenometric 3. Developer Resources & Portals Full-featuring APIs - Xovis
Xovis sensors allow the creation of custom counting zones (e.g., "Main Entrance", "Checkout Lane 4"). Data is retrieved based on these Zone IDs.
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. |
https://<sensor-ip-or-server-ip>/api/...https://api.xovis.io/...The Xovis API uses API Keys to authenticate requests. You can manage your API keys within the Xovis Cloud Dashboard under Settings > Integrations.
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.
Beyond simple counting, the Xovis API documentation details advanced telemetry that separates this system from basic infrared beam counters.
The primary function of the API is to fetch processed metrics rather than raw video streams.