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 API Documentation: A Comprehensive Guide

Xovis is a cutting-edge technology company that provides innovative solutions for various industries, including retail, healthcare, and more. One of the key offerings from Xovis is its API (Application Programming Interface), which allows developers to integrate Xovis' technology with their own applications. In this article, we will provide an in-depth look at the Xovis API documentation, covering its features, benefits, and usage guidelines.

What is Xovis API?

The Xovis API is a set of defined rules that enable different software systems to communicate with each other. It allows developers to access Xovis' technology, including its people counting and analytics solutions, and integrate them with their own applications. The API provides a secure and standardized way for developers to interact with Xovis' systems, enabling them to build custom solutions that meet their specific needs.

Features of Xovis API

The Xovis API offers a range of features that make it a powerful tool for developers. Some of the key features include:

Benefits of Xovis API

The Xovis API offers a range of benefits for developers and businesses alike. Some of the key benefits include:

Xovis API Documentation

The Xovis API documentation is a comprehensive guide that provides developers with the information they need to integrate Xovis' technology with their own applications. The documentation includes: xovis api documentation

Getting Started with Xovis API

To get started with the Xovis API, developers should follow these steps:

Xovis API Use Cases

The Xovis API has a range of use cases across various industries, including:

Best Practices for Using Xovis API

To get the most out of the Xovis API, developers should follow best practices, including:

Conclusion

The Xovis API documentation provides developers with a comprehensive guide to integrating Xovis' technology with their own applications. By following the guidelines outlined in this article, developers can unlock the full potential of the Xovis API, gaining valuable insights into customer behavior and optimizing their operations. Whether you're a retail business looking to optimize store layouts or a healthcare provider seeking to improve patient satisfaction, the Xovis API has the potential to transform your operations.

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

Retrieves average queue length and wait times for sensors configured with the Queue Analytics feature. The Xovis API documentation provides the technical framework

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

The Xovis API allows developers to retrieve real-time and historical person-counting data from Xovis 3D sensors. It is primarily used for retail analytics, airport flow management, and smart building occupancy monitoring.

Below is a structured "write-up" or guide for someone looking to document or use the Xovis API. 1. Introduction & Authentication

Xovis sensors typically provide a RESTful API that communicates via HTTP/HTTPS.

Access: Most sensors use Basic Authentication (username and password configured via the sensor's web interface). Format: Data is usually returned in XML or JSON formats.

Base URL: The API is often hosted directly on the sensor hardware (e.g., https://[SENSOR_IP]/api/). 2. Core API Endpoints

A good write-up should categorize endpoints by their function: Real-Time Data:

GET /api/v1/live/occupancy: Current number of people in a specific zone.

GET /api/v1/live/counts: Immediate "in/out" counts for lines/gates. Historical Data:

GET /api/v1/data/history: Fetch count data for a specific time range (requires from and until parameters). System Status:

GET /api/v1/system/info: Returns sensor firmware version, uptime, and health status. 3. Key Technical Components

To help developers integrate effectively, include these details:

Data Models: Explain what fields like objectCount, dwellTime, and queueLength mean in the context of Xovis. Response Codes: Document standard HTTP responses: 200 OK: Request successful. 401 Unauthorized: Authentication failed. 404 Not Found: Endpoint or data range does not exist.

Code Samples: Provide snippets in popular languages like Python or JavaScript to show how to make a request. 4. Integration Best Practices Benefits of Xovis API The Xovis API offers

Polling Frequency: Don't overload the sensor. For "Live" data, once every 5–10 seconds is usually sufficient.

Error Handling: Implement retry logic for network timeouts or sensor reboots.

Data Aggregation: Use the sensor's internal memory for historical data to avoid data loss during network outages. 5. Official Resources

If you are looking for the direct official documentation or tools to test the API:

Xovis Customer Hub: Most technical manuals and firmware-specific API docs are available behind the Xovis Customer Login.

API Testing Tools: You can use tools like Postman or Swagger to test your API calls before writing production code.

Without the API, reading data requires manually logging into the Xovis dashboard. With the API, data flows automatically into your existing business intelligence stack (Power BI, Tableau, Splunk, or custom ERP systems).

Xovis provides people-counting and tracking solutions via sensors; their API typically exposes endpoints for:

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.

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

Endpoint: GET /data/count

Query Parameters:

| Parameter | Type | Required | Description | | :--- | :--- | :--- | :--- | | sensor_id | string | Yes | The unique identifier of the sensor. | | zone_id | integer | No | Specific zone ID. If omitted, returns data for all zones. | | start_ts | datetime | Yes | Start time (ISO 8601 format, e.g., 2023-10-27T00:00:00Z). | | end_ts | datetime | Yes | End time (ISO 8601 format). | | granularity | string | No | Aggregation level (1h, 1d). Default is 1h. |

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
]