Get report
get_reportFetch Booksy Stats & Reports as JSON for a day, week, month or year. Get dashboard totals for appointments, revenue and clients, or pick a category and report key to pull full report tables.
Instructions
Numbers from Stats & Reports for a day, week, month or year, as JSON.
Returns one Stats & Reports category for a period: dashboard gives the totals for appointments, revenue and clients with the change against the previous period; any other category gives its highlight tables and the list of its reports. Pass report with a key from that list for the full report. Booksy counts one day, one Monday-to-Sunday week, one calendar month or one calendar year, so from and to must be such a period. Amounts come formatted in the business's currency. Booksy Biz Lite has the dashboard, revenue, appointments and clients; cash_flow, inventory, staff_members and marketing need Booksy Biz Pro.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Last day, inclusive: the same day, a Monday-to-Sunday week, a calendar month or year. | |
| from | Yes | First day, inclusive. | |
| report | No | Report key from `reports` of the category (e.g. appointments_summary) for its full tables. | |
| category | Yes | dashboard (totals), appointments, clients, revenue, cash_flow, staff_members, marketing, tips or inventory. | |
| staff_id | No | Staff member, only for the report performance_per_staffer. |