Skip to main content
GET
Aggregates signup-month cohorts by membership package or billing site.
This endpoint requires a tenant-scoped API key and is available only for eligible organizations.

Response

The response includes the applied dimension, signup-date coverage, dimension truncation metadata, and cohort rows.

Dimensions

dimension=none returns one row per signup month. dimension=plan groups by the membership’s current POS plan name. dimension=site groups by the membership’s current billing site code and resolved site name. For plan and site, Nautilus returns up to 250 dimension values for the requested range. Check dimensionValues.truncated to see whether lower-volume values were omitted.

Caveats

Memberships without signup dates are excluded from cohort rows and counted in signupDateCoverage.membershipsWithoutSignupDate. The plan and site dimensions use current recurring-account values, not signup-time values. Historical cohort composition can shift when a member changes plan or billing site. There is no normalized promotion or source cohort dimension in the current response.

Errors

  • 400 - Invalid dimension or cohort analytics are not available for this organization.
  • 401 - Missing, invalid, or non-tenant-scoped API key.
  • 500 - Internal server error.

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Query Parameters

start
string

Inclusive lower bound on cohort month. The value is truncated to its month.

end
string

Inclusive upper bound on cohort month. The value is truncated to its month.

dimension
enum<string>
default:none

Dimension used to group cohort rows.

Available options:
none,
plan,
site

Response

Cohort analytics response

organizationId
string
required
dateRange
Date range · object
required
source
string
required
Allowed value: "membership_signup"
available
boolean
required
dimension
enum<string>
required
Available options:
none,
plan,
site
signupDateCoverage
object
required
dimensionValues
object
required
cohorts
object[]
required