Sign in
Reports

Get practitioner occupancy report

Returns a practitioner occupancy report for the given date/time range, showing bookable, blocked, appointment and session minutes per practitioner. 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

Query parameters

date_time_fromstring date-time required
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). The range between date_time_from and date_time_to must not exceed 60 days.

date_time_tostring date-time required
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. The range between date_time_from and date_time_to must not exceed 60 days.

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.

Response

Practitioner occupancy report data.

Example response

{
  "data": [
    {
      "practitioner": {
        "id": "5dcb47800000000000000000",
        "name": "Jane Doe"
      },
      "bookable_mins": 2400,
      "blocked_mins": 120,
      "appointment_mins": 1800,
      "session_mins": 300
    }
  ],
  "totals": {
    "bookable_mins": 9600,
    "blocked_mins": 480,
    "appointment_mins": 7200,
    "session_mins": 1200
  }
}

Changes