Sign in
Reports

Queue an export of the room occupancy report

Queues a CSV export of the room occupancy report to be generated asynchronously.

get/shop/reports/room-occupancy/queue

Query parameters

site_idstring uuid

Restrict the report to the given site.

date_fromstring date required
Example:2026-06-01

Restrict to occupancy on or after this date. Required. The range between date_from and date_to cannot exceed 60 days.

date_tostring date required
Example:2026-06-30

Restrict to occupancy on or before this date. Required.

room_idsstring[]

A comma-separated list of room IDs to restrict to.

zone_idstring[]

A comma-separated list of zone IDs to restrict rooms to.

emailboolean

If true, email the completed CSV to the authenticated user when the background job finishes. Defaults to false, in which case the queued job's output URL must be polled via the queued-jobs endpoint.

Response

The job was successfully queued

Example response

{
  "data": {
    "created_at": "2023-11-07T00:00:00+00:00",
    "updated_at": "2023-11-07T01:00:00+00:00"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.