Reports

Queue an export of the sessions list

This endpoint queues an export of the sessions list.

get/shop/reports/sessions/queue

Query parameters

site_idstring uuid required

Filter the list of sessions by site.

datestring date

Example:2023-05-05

Include sessions on this date.

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

start_time_fromstring date-time

Include sessions starting on or after this date.

start_time_tostring date-time

Include sessions starting before this date.

session_type_idstring mongo-id

Include sessions of this type.

recurrence_group_idstring mongo-id

Include sessions with this recurrence group ("session time").

room_idstring mongo-id

Include sessions taking place in this room.

practitioner_idstring mongo-id

Include sessions carried out by this practitioner.

zone_idstring mongo-id

Include sessions taking place in this zone.

include_cancelledboolean

Include cancelled sessions.

cancelledboolean

Only return cancelled sessions.

The job was successfully queued

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

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