Reports

Get practitioner occupancy report by date

Returns a practitioner occupancy report for the given date/time range, showing bookable, blocked, appointment and session minutes per practitioner per day. The date range must not exceed 60 days. Requires the REPORTS_VIEW permission. When requesting a CSV export via the Accept: text/csv header, requires the REPORTS_DOWNLOAD permission instead.

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

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

Practitioner occupancy by date report data.

Example response

{
  "data": [
    {
      "date": "2024-01-15",
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "bookable_mins": 480,
      "blocked_mins": 60,
      "appointment_mins": 360,
      "session_mins": 60
    }
  ],
  "totals": {
    "bookable_mins": 9600,
    "blocked_mins": 480,
    "appointment_mins": 7200,
    "session_mins": 1200
  }
}

Changes

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