Skip to main content
GET
Revenue report for a period

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 revenue of this club - its bookings, plans, check-ins and the sales rung up there.

billingEntityId
integer

Only the revenue of this selling company, for an organization that trades through more than one.

compare
enum<string>
default:previous_period

What to compare the period with.

Available options:
previous_period,
previous_year,
none
granularity
enum<string>

How trend buckets the period. Chosen from the period's length when omitted.

Available options:
day,
week,
month
topItems
integer
default:10

How many items topItems lists.

Required range: 1 <= x <= 50

Response

The revenue report

period
object
timezone
string

The clock the days are read on.

currency
string
totals
object
comparison
object | null
byStream
object[]
byClub
object[]

Absent when the report is narrowed to one club.

byPaymentMethod
object[]

What collected the money. A sale paid by several methods counts under the one that paid most; 'Unattributed' is collected with no real-money payment behind it.

topItems
object[]

What sold most: a class or court, a plan, a product.

trend
object
movers
object[]

The streams, clubs and items whose revenue moved most against the comparison period, largest move first. Empty without a comparison.