Xovis Api Documentation May 2026

Retrieves aggregated people counting data (in/out counts) for a specified sensor or zone over a time range.

Endpoint: GET /counts

Query Parameters:

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | site_id | string | Yes | Unique identifier of the site/location | | sensor_id | string | No | Filter by a specific sensor | | zone_id | string | No | Filter by a specific zone (defined in Xovis config) | | start_time | string (ISO 8601) | Yes | Start of interval (e.g., 2026-04-11T00:00:00Z) | | end_time | string (ISO 8601) | Yes | End of interval | | granularity | string | No | minute, hour, day, week, month (default: hour) |

Response (200 OK):

  "status": "success",
  "data": 
    "interval": 
      "start": "2026-04-11T00:00:00Z",
      "end": "2026-04-11T23:59:59Z",
      "granularity": "hour"
    ,
    "series": [
"timestamp": "2026-04-11T10:00:00Z",
        "in": 142,
        "out": 98,
        "net": 44
      ,
"timestamp": "2026-04-11T11:00:00Z",
        "in": 203,
        "out": 187,
        "net": 16
],
    "totals": 
      "in": 345,
      "out": 285,
      "net": 60

For on-premises installations, the Xovis PC Tool offers a local API. The documentation here is noticeably different—more technical, less user-friendly.

Key Features Documented:

Documentation Critique: This section of the docs is dense and aimed at C++ or embedded developers. Examples are scarce. Many users complain that error handling (e.g., what happens when the socket drops) is poorly explained.

Xovis documentation takes security seriously but makes it cumbersome. xovis api documentation

Data is aggregated based on the requested granularity (granularity parameter):