Reporting

Booked-on summary

Returns revenue totals bucketed by when a booking was sold (the booked_at date), rather than when the event runs. Each bucket reports the amount already collected, the amount still expected from non-postponed bookings (split into projected vs. past due), the amount tied up in postponed bookings, and the count of bookings.

This is the right endpoint for sales-pipeline questions like "how much did we sell last month?" or "what was our best booking week?". For event-date-based projections, use revenue_projection_summary instead.

Proposals are excluded. Only confirmed (non-archived) bookings with a due_on set are considered. All monetary fields are reported in cents.

Required permission: reports_read

get/api/v1/reporting/booked_on_summary

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/reporting/booked_on_summary
  • Auth: none declared. Required headers: Api-Key

Query parameters

interval'year' | 'quarter' | 'month' | 'week' | 'day'

Time-bucket size. Defaults to month.

starts_atstring

Start of the date range (YYYY-MM-DD), applied against booked_at. Defaults to one year ago. Snapped to the beginning of the chosen interval.

ends_atstring

End of the date range (YYYY-MM-DD), applied against booked_at. Defaults to today. Snapped to the end of the chosen interval.

brand_idinteger

Limit results to a single brand. Omit to include all brands on the account.

Headers

Api-Keystring required

Your Integration Key

Response

booked-on summary

Changes

No recorded changes to this operation across all 2 revisions of this API.