Xovis Api Documentation File

All requests follow a standard pattern: http://<XCS_Server_IP>/api/v1/<endpoint>

Example: http://192.168.1.100/api/v1/occupancy/current

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 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 provides comprehensive API documentation primarily through its partner platform and dedicated support portals. Accessing Documentation xovis api 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

The Xovis API ecosystem is designed to bridge the gap between high-precision 3D sensing and actionable business intelligence. By exposing core sensor functionalities through a robust REST API and data push options, Xovis allows developers to integrate real-time people flow data directly into custom software environments, such as retail analytics platforms, airport management systems, and smart building dashboards. Core API Capabilities

REST Interface & Data Push: Sensors feature a native REST API for direct device control and data retrieval, alongside flexible data push options that stream pre-processed information to external servers.

Real-Time KPI Access: Developers can pull critical metrics including queue lengths, wait times, and process times for specific lanes or passenger groups.

Sensor Management: The API supports remote configuration, status monitoring (using combined /info and /info/status endpoints), and health checks like is_alive? to ensure system reliability. The Xovis API uses API Keys to authenticate requests

Edge Processing: Data is pre-processed directly on the sensor to maintain full privacy compliance (GDPR), ensuring only anonymous, actionable insights are transmitted. Key Integration Features

Data Persistence: Sensors can store gathered data for up to 120 days locally, providing a buffer that ensures high-quality insights even during temporary network outages.

AI Plugin Control: The API enables the management of specialized AI plugins, such as Gender Statistics (PIGES) and Staff Exclusion (PISTE), allowing for more granular data filtering and analysis.

Multisensor Synchronization: For large-scale areas, the API facilitates the combination of up to 200 sensors via the Xovis SPIDER, enabling seamless path tracking across massive physical footprints.

Polling Flexibility: Integration tools like the Xovis User Guide for Niagara 4 allow for adjustable polling frequencies (Fast, Normal, Slow) to balance data freshness with network overhead. Common API Endpoints & Methods

Based on driver documentation, standard implementation methods include:

capacity_data / count_data: Retrieve live occupancy and throughput statistics.

reset_count: Remotely clear sensor counts for session-based tracking.

on_update: A callback-style method to trigger actions when new data is detected.

get_logs: Fetch system logs for troubleshooting and audit trails. 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: https://api

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

The Xovis API uses API Keys to authenticate requests. You can manage your API keys within the Xovis Cloud Dashboard under Settings > Integrations.

The API utilizes secure authentication methods to protect sensitive location data.

Requesting 2 years of 1-minute interval data will time out. The documentation recommends pagination parameters (limit and offset) for large historical exports.

Best Practice Snippet: GET /counts/interval?start=2023-01-01&end=2023-12-31&interval=PT1H&limit=1000&offset=0

https://api.xovis-cloud.com/v1

Security is paramount. The Xovis API primarily uses API Key authentication. You cannot access endpoints without a valid key generated within the XCS settings.

From the docs: