Skip to content

Export Booking Insights

GET
/appointments/bookings/insights/export

The bookings behind GET /appointments/bookings/insights, one row each, as CSV.

An Admin key sees the team (or member_user_id’s); anyone else sees their own bookings only - the same split the insights read makes.

Authorizations

Parameters

Query Parameters

date_from
Any of:
string

ISO date. Omit for all time.

date_to
Any of:
string

ISO date. Omit for all time.

event_type_ids
Any of:
string
/^\s*\d+\s*(,\s*\d+\s*)*$/

CSV of INTEGER event type ids. Checked here because the app splits and int()s it unguarded.

member_user_id
Any of:
integer

One member’s bookings. Honoured for Admin keys only.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A CSV export, carried inside the JSON envelope.

The app streams these as text/csv attachments. Every other operation in this contract answers with the ApiResponse envelope, and an SDK method that sometimes returns JSON and sometimes a byte stream is a trap, so the CSV text is returned as a string field instead.

object
content_type
string
default: text/csv
csv
required

The full CSV document, header row first.

string
filename
required
string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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