Skip to content

Get aggregated booking insights

GET
/appointments/bookings/insights

Return aggregated booking insights for the caller’s org.

Covers booking counts, show/no-show rates, and per-event-type breakdowns for the given date window. Backed by BookingsHandler.handle_insights (same handler as the in-app insights view). is_admin is forced False so the caller sees only their own data. The in-app member_user_id filter is intentionally NOT exposed: it is an admin-only knob and an API key never holds admin, so the handler would ignore it anyway - omitting it from the route signature avoids the misleading “forwarded but ignored” surface.

Authorizations

Parameters

Query Parameters

date_from
Any of:
string

ISO date string for range start (e.g. ‘2026-01-01’).

date_to
Any of:
string

ISO date string for range end (e.g. ‘2026-12-31’).

event_type_ids
Any of:
string

Comma-separated event-type IDs to filter by.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
key
additional properties
any

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string