Skip to content

Analytics

End-of-day rollup for any single date (defaults to yesterday in the brand’s timezone). Returns total bookings, total covers, breakdown by status (completed / no-show / cancelled / etc.), completion rate, no-show rate, and walk-in count. Use this for the morning ‘how did last night go?’ summary.

Required scope: reports.read

Parameter Type Required Description
brand string no Brand slug.
date string no YYYY-MM-DD in brand-local TZ. Defaults to yesterday.

List guests whose last completed visit was more than `minDaysSinceVisit` days ago. Sorted by most-recent first (so freshly dormant guests bubble up). Use for re-engagement SMS / email targeting (“anyone we haven’t seen in 90 days?”).

Required scope: guests.read

Parameter Type Required Description
brand string no Brand slug.
minDaysSinceVisit number no Cutoff in days. Default 90. Lower = more dormant guests, higher = only deep dormancy.
limit number no Max results, default 25, max 100.

List reservations still in `pending_confirmation` (the attendance-confirmation nudge has been sent but the guest hasn’t replied). Use this to chase confirmations before they auto-cancel. Defaults to the next 48 hours.

Required scope: bookings.read

Parameter Type Required Description
brand string no Brand slug.
hoursAhead number no How far ahead to scan. Default 48h, max one week.

Covers + bookings grouped by hour over the next N days (defaults to 7). Each row is `{date, time, covers, bookings}` so the LLM can spot quiet hours, dense ones, or empty days worth promoting. Counts every active + completed reservation — purely a forward-look at how the books are pacing.

Required scope: reports.read

Parameter Type Required Description
brand string no Brand slug.
daysAhead number no How far forward to project. Default 7, max 30.
fromDate string no Optional override start date (YYYY-MM-DD, brand TZ). Defaults to today.

Loyalty health check. For the last `windowDays` (default 30), what fraction of customers who completed a visit had also visited before? Returns counts + percentage so the operator can track whether they’re growing the regulars cohort or churning new guests.

Required scope: reports.read

Parameter Type Required Description
brand string no Brand slug.
windowDays number no Lookback window in days. Default 30.