Sign in
Reports

Queue an export of the practitioner utilisation report

Queues a CSV export of the practitioner utilisation report. Use this in preference to the synchronous endpoint when the report needs to be delivered to multiple recipients or when the calling context cannot wait for the synchronous response.

get/shop/reports/practitioner-utilisation/queue

Query parameters

site_idstring uuid required

Restrict the report to the given site. Required.

date_fromstring date required
Example:2026-06-01

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

date_tostring date required
Example:2026-06-30

Restrict to bookings on or before this date. Required.

zone_idstring[]

A comma-separated list of zone IDs to restrict practitioners 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.