Reports
Answer questions about an event, such as who's coming, check-ins, dietary needs, rooming and session numbers, with the report tools instead of reading every record.
Use one report call instead of reading hundreds of records. Report tools are read-only, except for the catering export.
| Question | Tool |
|---|---|
| RSVPs, check-ins, numbers per session | events__getEventReport |
| Dietary needs across the event: counts, allergens, anaphylaxis, who still hasn’t answered | guests__getEventDietaryReport |
| Accessibility needs: counts by need, per-guest list | guests__getEventAccessibilityReport |
| One meal’s numbers and plate count | agenda_items__getActivityDietaryReport |
| The kitchen sheet for one meal (CSV) | agenda_items__exportActivityCateringSheet, which marks the sheet as exported; dry-run first |
| Anything custom (“guests with no hotel, by ticket type”) | reports__getReportDataset (one row per guest, with dietary, ticketing, travel, custom fields and form answers), or reports__generateReportSpec to turn a plain-English request into columns, filters and grouping |
| Who can get push or SMS | comms_edge__eventCommsReport |
| Billing for this event: package, people included, used | billing__getEventBillingStatus (organization admins) |
Billing guardrails
- Never activate, change or pay for a plan. Tell the organizer what the billing status says and let them act in the console.
- Don’t quote prices; they’re set per agreement.
- An event’s people limit is a hard cap. Adding guests past it fails, so check the billing status before a large import.