Occupancy report

post

https://access.lumana.ai/v1/reports/occupancy

Flow metrics and occupancy tracking per hour, driven by the configured entrances/exits. One row per
day per hour with inward/outward counts, peak and mean presence. entrancesAndExits, objectType
(PEOPLE/VEHICLE), resetInterval (DAY/WEEK), resetTime (HH) and resetTimezone
are required; timeRange ({ startTime, endTime }) bounds the window (max
92 days). Paginated with page/size.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

entrancesAndExits

array of strings

required

Occupancy sources, not camera ids. Accepts entrance/exit event ids (line-crossing/counting events) and counting-enabled zone ids, in any mix. List them with GET /v1/dictionary/entrances and GET /v1/dictionary/zones. Ids that are neither are rejected with 400. Required.

entrancesAndExits*

objectType

string

enum

required

The subject entity to count. Required.

Allowed:

timeRange

object

required

The query window, milliseconds since epoch.

timezone

string

Defaults to UTC

IANA timezone used to align dates and reset boundaries. Defaults to UTC.

resetInterval

string

enum

required

Window to flush the internal counter metrics. Required.

Allowed:

resetTime

string

required

Hour boundary (00-23) to trigger the numerical reset. Required.

resetDay

string

enum

Day the counter resets on for WEEK intervals. Defaults to SUNDAY.

Allowed:

resetTimezone

string

IANA timezone governing the counter reset schedule. Optional — occupancy currently aligns resets to timezone, so this is reserved for future per-reset alignment.

resetMode

string

enum

Defaults to TIME

How the counter reset boundary is chosen. TIME uses resetInterval/resetTime/resetDay. SCHEDULE uses resetScheduleId instead. Defaults to TIME.

Allowed:

resetScheduleId

string

Saved schedule driving the reset boundary. Required when resetMode is SCHEDULE, and rejected otherwise. List available ids with GET /v1/dictionary/schedules.

resetValueMode

string

enum

Defaults to FIXED

What the counter resets to. FIXED resets to resetToValue. BY_ZONE_COUNTING resets to the live sum of resetZoneIds. Defaults to FIXED.

Allowed:

resetToValue

number

Defaults to 0

Value the counter resets to when resetValueMode is FIXED. Defaults to 0.

resetZoneIds

array of strings

Counting-enabled zone ids whose live sum becomes the reset base. Required when resetValueMode is BY_ZONE_COUNTING. List them with GET /v1/dictionary/zones.

resetZoneIds

page

number

Defaults to 0

Zero-based page index.

size

number

Defaults to 50

Page size (1..100).

Responses

400

Invalid timeRange, date range too large, or invalid parameters.

401

Missing or invalid API key.

403

Organization not allowed by this token.

500

Internal server error.

200The occupancy report page.