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
Pros:
Cons:
Overall:
Great for technical teams already familiar with REST APIs, but beginners may struggle with conceptual leaps. The documentation is accurate but not very learning-friendly. Xovis support usually fills the gaps quickly.
Would you like a deeper look at a specific aspect, such as authentication flow or endpoint examples? xovis api documentation
Before diving into the code, it is essential to understand the flow of data. Xovis sensors (like the PC2 or PC3 series) operate independently or through the Xovis Counting Service (XCS) – the central software that aggregates data from multiple sensors.
The Xovis API is a RESTful web API that allows external applications to communicate with the XCS. It returns data in standard JSON format, making it universally compatible with cloud services, on-premise databases, and modern web frameworks. and modern web frameworks.