Api Documentation: Xovis

Inside Xovis API Documentation: A Technical Deep Dive for Integrators

In the world of people counting and foot traffic analytics, Xovis is a premium player, known for its high-accuracy 3D stereo vision sensors. While their hardware and PC-based software (Xovis PC Tool) are well-regarded, their API documentation is the critical bridge that turns raw counting data into actionable business intelligence.

This article explores the structure, capabilities, and gaps in the official Xovis API documentation, aimed at system integrators, IT managers, and developers.

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
]

C. Zone & Configuration Management

Zone Definitions: Retrieve the configuration of counting lines and zones set up within the Xovis sensor web interface.
Hierarchy Management: (Xovis Data Platform) Manage the tree structure of sites, floors, and areas.

Mastering Crowd Intelligence: The Ultimate Guide to Xovis API Documentation

In the age of smart buildings and data-driven retail, accurate people counting has transitioned from a luxury to a necessity. Xovis, a Swiss leader in high-precision people flow analysis, stands at the forefront of this industry. Their 3D stereo vision sensors are renowned for millimeter-precision counting, but the true power of these sensors is unlocked through their Application Programming Interface (API).

For developers and system integrators, the Xovis API documentation is the key to transforming raw pedestrian data into actionable business intelligence. Whether you are looking to integrate real-time occupancy data into a building management system (BMS), feed footfall metrics into a CRM, or trigger automated alerts in a queue management dashboard, understanding this documentation is critical. xovis api documentation

This article serves as a deep dive into the Xovis API ecosystem. We will explore the architecture, authentication methods, data endpoints, and best practices for leveraging the official documentation to build robust, scalable integrations.

Core Capabilities of the Xovis API:

Real-time Occupancy: Fetch current occupancy levels for a specific zone (e.g., "Zone A has 45 people, capacity is 100").
Historical Data: Retrieve footfall counts for specific time intervals (15 min, hourly, daily).
Queue Metrics: Access average waiting time, queue length, and service speed.
Directional Flow: Understand entry vs. exit rates (In/Out counts).
Device Management: Remotely monitor sensor health and configuration status.

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).

Header Authentication

Include your API key in the header of every request: Inside Xovis API Documentation: A Technical Deep Dive

X-API-Key: your_api_key_here
Content-Type: application/json

Rate limits & Pagination

Expect paginated responses for large result sets (page, limit or next cursor).
Respect rate-limit headers (Retry-After) and implement exponential backoff.