Reports

Queue practitioner occupancy by date report export

Queues a practitioner occupancy by date report for asynchronous CSV export. Returns a queued job resource that can be polled for completion. Requires the REPORTS_DOWNLOAD permission.

get/shop/reports/practitioner-occupancy-by-date/queue

Query parameters

date_time_fromstring date-time

Example:2024-01-01T00:00:00+00:00

The start of the reporting period as an ISO 8601 date-time string (e.g. 2024-01-01T00:00:00+00:00). Required if date_from is not provided. The range between date_time_from and date_time_to must not exceed 60 days.

date_time_tostring date-time

Example:2024-01-31T23:59:59+00:00

The end of the reporting period as an ISO 8601 date-time string (e.g. 2024-01-31T23:59:59+00:00). Must be after date_time_from. Required if date_to is not provided. The range between date_time_from and date_time_to must not exceed 60 days.

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.

practitioner_idsstring

Example:5dcb56d0-59fe-4581-83e1-a7b7c2d3e4f5,6eca67e1-6aff-5692-94f2-b8c8d3e4f5a6

A comma-separated string of practitioner IDs to filter the report to specific practitioners.

site_idstring uuid

Example:5dcb56d0-59fe-4581-83e1-a7b7c2d3e4f5

The site ID to scope the report to.

zone_idstring nullable

Example:5e932c0901d210625e3a8766,5e932c0901d210625e3a8768

A comma-separated string of zone IDs to filter by.

Response

The report has been queued for export.

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.