Occupancy flex report

post

https://access.lumana.ai/v1/flex-reports/occupancy-report

Occupancy report returning the dashboard occupancy display (average and max occupancy) for the
provided entrancesAndExits (occupancy event ids) over the timeRange. objectType defaults to
PEOPLE.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

entrancesAndExits

array of strings

required

Occupancy sources driving the count. Accepts entrance/exit event ids 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

The subject entity. Defaults to PEOPLE.

Allowed:

timeRange

object

required

The time window, milliseconds since epoch.

timezone

string

IANA timezone. Defaults to UTC.

resetInterval

string

enum

Defaults to DAY

Window to flush the internal counter metrics. Defaults to DAY.

Allowed:

resetTime

string

Defaults to 00

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

resetDay

string

enum

Defaults to SUNDAY

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

Allowed:

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

Responses

200

The occupancy display payload.

400

Invalid request.

401

Missing or invalid API key.

403

Organization not allowed by this token.

500

Internal server error.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!