The booking report of a range of days
https://api.app2email.com/v1/{number}/bookings/reports Scope: bookings:manage (or messages:read). Over the appointments whose START is in the range (days in the business time zone): totals (bookings, upcoming, completed, cancelled and by the customer, no-shows, the no-show and cancel rates, new and returning customers, revenue and refunds in minor units, the average days booked ahead, the online share), per day, per weekday and hour, per service, staff member and source, and the waitlist numbers. Revenue = online payments of those appointments, less refunds. The range: from / to (at most 366 days), or days (the last N days up to today; default 30). With days=7, 30 or 90 (or nothing) the answer also has the keys of the older report (bookings, completed, cancelled, no_shows, csat, reminders_sent, sessions, top_services, per_provider, nudges). format=csv: one line per appointment (reference, date, time, service, staff, customer name, customer phone, status, source, price, paid, add-ons, guests, series, answers); format=csv_summary: the older metric,value lines.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- from string
The first day, YYYY-MM-DD in the business time zone.
e.g.2026-11-01 - to string
The last day (included). With from alone: from + 29 days.
e.g.2026-11-30 -
Instead of from / to: the last N days up to today (1 to 366; 7, 30 or 90 also give the older keys). Default 30.
- service_id string
Only this service (service is taken too).
- provider_id string
Only this staff member (provider is taken too).
- format string
csv: one line per appointment. csv_summary: the older metric,value lines.
jsoncsvcsv_summary
Responses
Fields
- success boolean
- request_id string
- days integer
73090 - from string (date-time)
- to string (date-time)
- bookings object
- completed integer
- cancelled object
- no_shows integer
- no_show_rate number
no_shows / (completed + no_shows).
- csat object
- reminders_sent integer
- sessions object
Flow sessions started and completed (the conversion of the form).
3 fields
- started integer
- completed integer
- conversion number
- top_services object[]
- per_provider object[]
- nudges object
1 fields
- rebook integer
- error string
Only when the numbers could not be computed.
- range object
The days of the report (business time zone, both included).
- filters object
- totals object
Over the appointments whose START is in the range.
15 fields
- booked integer
- confirmed_upcoming integer
- completed integer
- cancelled integer
- cancelled_by_customer integer
- no_show integer
- new_customers integer
- returning_customers integer
- revenue_minor integer
- refunded_minor integer
- no_show_rate number
- cancel_rate number
- currency string
- avg_lead_days number | null
- by_day object[]
5 item fields
- date string
- booked integer
- cancelled integer
- no_show integer
- revenue_minor integer
- by_weekday_hour object[]
Not cancelled appointments per start weekday (0 = Monday) and hour; only the cells that have some.
- by_service object[]
- by_provider object[]
- by_source object[]
- waitlist object | null
The waitlist entries of the days of the range. null while the waitlist is not available.
- truncated boolean
true when the range has over 50000 appointments (only the first 50000 are counted).
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.