Get booking summary
get_booking_summaryBooking activity for bookings made between start_date and end_date (the day the booking was taken, not the day the class runs): confirmed bookings, seats, cancellations with a cancellation rate, and failed payments, grouped by day, month (default), class, instructor, location or price_option. With no dates it covers the 30 days ending today. Its booked_value_cents is not revenue, as it does not net off refunds or include gift cards and buyouts; for any money question, use get_revenue_summary.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_booking_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | last day to include, inclusive, YYYY-MM-DD; when left out it is today, or the 30th day from start_date when only start_date is given | |
| group_by | No | day, month, class, instructor, location, or price_option; defaults to month | |
| start_date | No | first day to include, YYYY-MM-DD in the studio's timezone; when left out the window is the 30 days ending on end_date |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | ||
| from | Yes | ||
| note | Yes | ||
| seats | Yes | seats across those confirmed bookings | |
| groups | Yes | ||
| bookings | Yes | confirmed bookings created in the window | |
| canceled | Yes | bookings created in the window that are now canceled | |
| currency | Yes | ||
| group_by | Yes | ||
| timezone | Yes | ||
| truncated | No | ||
| payment_failed | Yes | bookings whose payment failed | |
| booked_value_cents | Yes | sum of the totals of the confirmed bookings, in cents | |
| cancellation_rate_percent | Yes |