Class attendance and fill-rate summary
class_attendance_summaryAnswers class attendance questions in one call: how full classes were (or are booked), which class types, teachers, locations and times fill best, and how many booked clients signed in. Reads every class in a date range, past or upcoming (up to 92 days), and returns totals (classes, canceled, capacity, booked, waitlisted, fill rate, full and empty classes, average booked) and breakdowns by class type, teacher (with substitute classes), location and time slot, plus optional by weekday, by day or week, and the fullest and emptiest classes, and a comparison with the previous period. Canceled classes are counted on their own and left out of every rate. Fill rate is booked / capacity, over classes that have a capacity. For classes that have ended, signedIn, signInRatePct and notSignedIn (booked but not signed in: no-shows and unchecked bookings) are reported only when the studio records sign-ins, over every program; for the not-signed-in rate over only the programs that record sign-ins, use class_mix. Filters by location, teacher, program or class type IDs. Use this instead of find_classes for attendance and fill-rate questions. Mindbody calls: 1 per 200 classes, doubled with compareToPrevious (at most 50).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| top | No | Rows per ranked breakdown, and classes in fullest and emptiest, 1-25 (default 10). The rest of a breakdown is folded into one "other" row. | |
| range | No | Date range (default last_30_days). The last_* ranges and month_to_date end today; next_* start today. Use startDate/endDate for other ranges. | |
| siteId | No | Site to call (SiteId header). Default -99. | |
| endDate | No | Last day, inclusive (default today). At most 92 days after startDate. | |
| include | No | Breakdowns besides totals (default byClass, byStaff, byLocation, byTimeSlot). byTimeSlot is weekday and start hour, busiest first; byWeekday lists Monday to Sunday; byPeriod is by day up to 31 days, else by week; fullest and emptiest list individual classes. | |
| staffIds | No | Only classes taught by these staff members (get_staff). | |
| startDate | No | First day, e.g. 2026-09-01 (business-local). Default: 30 days ending endDate. | |
| programIds | No | Only classes in these programs (get_programs). | |
| locationIds | No | Only classes at these locations (get_locations). | |
| compareToPrevious | No | Also total the previous period (doubles the classes calls) and report the change: classes and bookings in percent, fill and sign-in rates in points. Whole calendar months compare with the previous whole months, other ranges with the same number of days just before. | |
| classDescriptionIds | No | Only these class types (get_class_descriptions). |