Reports

Report endpoints return aggregate summaries only. They are intended for dashboards and synchronization checks, not row-level data export. The authenticated company is always derived from the Bearer token. Requests must not include companyId, and report DTOs do not expose individual clients, bookings, invoices, payment IDs, coach IDs, or provider payloads.

Scopes

Scope	Allows
`attendance_summaries:read`	Read aggregate booking attendance counts.
`revenue_summaries:read`	Read aggregate invoice revenue totals.
`retention_summaries:read`	Read aggregate client relationship and portal status counts.

Attendance summary

GET /public/v1/reports/attendance-summary?dateFrom=2026-07-01T00:00:00.000Z&dateTo=2026-07-31T23:59:59.999Z
Authorization: Bearer <access_token>

Required scope: attendance_summaries:read Validation:

Parameter	Type	Required	Rule
`dateFrom`	ISO date-time	no	Optional range start. Must be paired with `dateTo` when supplied.
`dateTo`	ISO date-time	no	Optional range end. Must be after `dateFrom`.

Default range: last 30 days. Maximum range: 366 days. Response fields:

Field	Type	Nullable	Description
`data.attendanceSummary.dateFrom`	string	no	Parsed UTC range start.
`data.attendanceSummary.dateTo`	string	no	Parsed UTC range end.
`data.attendanceSummary.totals.bookings`	integer	no	Total booking rows in range.
`data.attendanceSummary.totals.persons`	integer	no	Sum of counted persons.
`data.attendanceSummary.totals.confirmedBookings`	integer	no	`Planned` and `Completed` bookings.
`data.attendanceSummary.totals.confirmedPersons`	integer	no	Persons for `Planned` and `Completed` bookings.
`data.attendanceSummary.totals.waitingBookings`	integer	no	Waiting-list bookings.
`data.attendanceSummary.totals.pendingBookings`	integer	no	Pending booking requests.
`data.attendanceSummary.totals.cancelledBookings`	integer	no	Bookings with a status starting with `Cancelled`.
`data.attendanceSummary.byStatus[].status`	string	no	Booking status bucket.
`data.attendanceSummary.byStatus[].bookings`	integer	no	Booking count in the bucket.
`data.attendanceSummary.byStatus[].persons`	integer	no	Counted persons in the bucket.

Revenue summary

GET /public/v1/reports/revenue-summary?dateFrom=2026-07-01T00:00:00.000Z&dateTo=2026-07-31T23:59:59.999Z
Authorization: Bearer <access_token>

Required scope: revenue_summaries:read Validation:

Parameter	Type	Required	Rule
`dateFrom`	ISO date-time	no	Optional range start. Must be paired with `dateTo` when supplied.
`dateTo`	ISO date-time	no	Optional range end. Must be after `dateFrom`.

Default range: last 30 days. Maximum range: 366 days. Only Invoice documents are included; credit notes are excluded. Response fields:

Field	Type	Nullable	Description
`data.revenueSummary.dateFrom`	string	no	Parsed UTC range start.
`data.revenueSummary.dateTo`	string	no	Parsed UTC range end.
`data.revenueSummary.currency`	string	no	Currency code used for the summary.
`data.revenueSummary.totals.invoiceCount`	integer	no	Total invoice count.
`data.revenueSummary.totals.totalPrice`	number	no	Sum of invoice totals.
`data.revenueSummary.totals.totalVat`	number	no	Sum of VAT totals.
`data.revenueSummary.totals.paidTotal`	number	no	Sum for `Paid` invoices.
`data.revenueSummary.totals.openTotal`	number	no	Sum for `Pending` invoices.
`data.revenueSummary.totals.chargebackTotal`	number	no	Sum for `Chargeback` invoices.
`data.revenueSummary.byStatus[].status`	string	no	Invoice status bucket.
`data.revenueSummary.byStatus[].invoiceCount`	integer	no	Invoice count in the bucket.
`data.revenueSummary.byStatus[].totalPrice`	number	no	Total price in the bucket.
`data.revenueSummary.byStatus[].totalVat`	number	no	VAT total in the bucket.

Not exposed: invoice numbers, client IDs, payment IDs, payment-provider payloads, line items, PDFs, billing-profile snapshots, or email history.

Retention summary

GET /public/v1/reports/retention-summary
Authorization: Bearer <access_token>

Required scope: retention_summaries:read Response fields:

Field	Type	Nullable	Description
`data.retentionSummary.generatedAt`	string	no	Summary generation timestamp.
`data.retentionSummary.totals.relationships`	integer	no	Total company-client relationship rows.
`data.retentionSummary.totals.activeRelationships`	integer	no	Relationships with `active` status.
`data.retentionSummary.totals.pendingApproval`	integer	no	Relationships pending approval.
`data.retentionSummary.totals.archivedRelationships`	integer	no	Archived relationships.
`data.retentionSummary.totals.rejectedRelationships`	integer	no	Rejected relationships.
`data.retentionSummary.relationshipStatuses`	object	no	Counts keyed by relationship status.
`data.retentionSummary.memberStatuses`	object	no	Counts keyed by member status.
`data.retentionSummary.portalAccessStatuses`	object	no	Counts keyed by portal access status.

Not exposed: client identity, email, phone, assigned coach, exact lifecycle timeline, archive reasons, deletion metadata, or private notes.

Rate limits

Report endpoints use the standard Public API client rate limit: 10 requests per second per OAuth client. Responses include the standard RateLimit-* and X-RateLimit-* headers documented in Contracts.

Start here

Public API guides

Access Devices

Scopes

Attendance summary

Revenue summary

Retention summary

Rate limits

​Scopes

​Attendance summary

​Revenue summary

​Retention summary

​Rate limits

Scopes

Attendance summary

Revenue summary

Retention summary

Rate limits