Xovis Api Documentation !!exclusive!! -

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

Data formats

JSON for requests and responses.
Timestamps typically in ISO 8601 (UTC).

Conclusion: Good, Not Great

The Xovis API documentation is functional and covers most enterprise use cases—especially for retrieving counts and occupancy. However, it suffers from fragmentation across hardware versions, vague performance limits, and a lack of a testing sandbox.

Who is it for?

✅ Developers with access to physical Xovis sensors or a cloud tenant.
✅ Integrators building dashboards for retail or transport hubs.
❌ Beginners hoping to prototype without hardware.

Final Verdict:
If you already own Xovis hardware, the API docs will get the job done, but budget extra time for trial-and-error on real-time streams and rate limiting. If you’re evaluating vendors, Xovis’s API is above average, but competitors offer a smoother onboarding experience.

Recommendation to Xovis:
Add a public sandbox, clearly version endpoints by sensor firmware, and publish rate-limit headers in responses. These three fixes would make your API documentation industry-leading.

This review is based on publicly available Xovis documentation and community feedback as of 2025. Always refer to the official Xovis Developer Portal for the latest updates. xovis api documentation

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 high-precision 3D sensors used for people flow management in industries like retail, airports, and public transport. To enable custom data intelligence, Xovis offers a robust REST API and various data push mechanisms that allow developers to integrate real-time movement data into their own software environments. Core Integration Methods

There are two primary ways to retrieve data from Xovis sensors:

REST API: Best for pull-based requests where your system queries the sensor for specific information, such as real-time status or historical data stored on the device for up to 120 days.

Data Push (Agents & Connections): Used for automated, real-time data delivery. In firmware v5 and higher, this is managed through "Logics," where you define a Connection (the destination server) and an Agent (the data format and type being sent). Authentication and Security Xovis 3D Sensors provide two primary methods for

Xovis prioritizes security while ensuring ease of access for developers:

Basic Authentication: Most sensor-level APIs, including the Sensor V5 API, use standard Basic Auth (Username and Password).

Bearer Tokens: Integration with intermediate platforms (like IoT Open) may require Bearer token authentication.

On-Sensor Processing: 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

For sensors running firmware v5+, developers can interact with several key data types:

Line Crossing Events: Triggered immediately when a person crosses a predefined line.

Aggregated Counts: Sent at pre-configured intervals (e.g., every 5 or 15 minutes).

Data Formats: Data push objects typically use JSON, while sensor status reports often use XML.

Real-time Protocols: Modern sensors support MQTT for instant, low-latency pedestrian flow reporting. Remote Management via Xovis HUB

The Xovis Device Control API, accessible through the Xovis HUB or Xovis Cloud, allows for large-scale fleet management. This centralized API enables you to: Update firmware for multiple sensors simultaneously.

Monitor sensor availability and status in real-time across different locations. Data formats

Remotely manage licenses for AI extensions like Gender Statistics or Staff Exclusion. Developer Resources

API Specification: Detailed documentation and an OpenAPI spec for firmware v5 can be found on the Postman API Network.

Integration Guides: Industry-specific case studies, such as the Transportation Eurostar Study, provide context on how wait times and throughput KPIs are implemented in real-world scenarios.

Since Xovis deals with passenger counting, queue management, and flow analytics, the API focuses heavily on retrieving metrics and understanding sensor status.

A. Get Counting Data

Retrieves people counting data (In, Out, Passby) for a specific sensor or zone.

Endpoint: GET /data/count

Query Parameters:

Example Request:

curl -X GET "https://api.xovis.io/v3/data/count?sensor_id=SNSR_001&start_ts=2023-10-01T00:00:00Z&end_ts=2023-10-01T23:59:59Z&granularity=1h" \
-H "X-API-Key: your_api_key_here"

Example Response:


  "sensor_id": "SNSR_001",
  "location_id": "LOC_NYC_05",
  "data": [
"timestamp": "2023-10-01T08:00:00Z",
      "in": 145,
      "out": 132,
      "passby": 50,
      "occupancy": 13
    ,
"timestamp": "2023-10-01T09:00:00Z",
      "in": 210,
      "out": 195,
      "passby": 65,
      "occupancy": 28
]

Major API categories (typical)

Authentication / session management
Device discovery & inventory
Real-time streams (people counts, occupancy, events)
Historical data / aggregated analytics
Configuration / device settings (zones, thresholds, timezones, firmware)
Health & diagnostics (status, uptime, sensor temperature)
Alerts & webhooks

Step 1: Read the Request Parameters

According to the Xovis API documentation, the /occupancy/current endpoint supports optional filtering by locationId. If omitted, it returns all zones.

Request Example: GET http://xcs.local/api/v1/occupancy/current?locationId=store_main_floor