Skip to main content
GET
Who cancels, how late, and where

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Query Parameters

from
string<date>
required

First day of the period (YYYY-MM-DD), on the organization's clock.

to
string<date>
required

Last day of the period, inclusive.

clubId
integer

Only the bookings of this club.

areaTypeId
integer

Only the bookings of this area type.

instructorIds
string

Only the bookings these instructors teach or coach, comma-separated.

Example:

"3,7"

classTypeIds
string

Only the seats on these class types, comma-separated.

programIds
string

Only the seats on these programs' class types, comma-separated.

limit
integer
default:100

How many rows a page holds.

Required range: 1 <= x <= 500
offset
integer
default:0

How many rows to skip.

Required range: x >= 0

Response

The report, with a page of its people

period
object
timezone
string
totals
object
lateWindows
object[]

The rules the cancellations were judged late by.

byClassType
object[]
byArea
object[]
bySlot
object[]
rowsScope
enum<string>

The scope the rows need: without it rows and total are null and the figures come alone.

Available options:
contacts:read
total
integer | null

Every row, across all pages; null when the rows are withheld.

limit
integer
offset
integer
rows
object[] | null

By customer: the customers who cancel most, each with their contactId, name and email.