Skip to main content
GET
Members 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 own clock.

to
string<date>
required

Last day of the period, inclusive.

compare
enum<string>
default:previous_period

What to compare the period with.

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

How trend steps through the period. By day for a month or less, by week beyond, when omitted.

Available options:
day,
week

Response

The report

period
object
timezone
string

The clock the days are read on: the organization's timezone, as on the admin analytics dashboards.

current
object

Right now, whatever the period.

totals
object
comparison
object | null
trend
object

The counts at the end of each day or week.

lifecycle
object | null

Moves between contact types in the period. Null when the caller lacks contacts:read.