Skip to main content
GET
Get retention cohorts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string

Inclusive first cohort date, as YYYY-MM-DD or an ISO 8601 instant. Supply with end_date; omit both for the last 90 days of cohorts.

end_date
string

Inclusive last cohort date, as YYYY-MM-DD or an ISO 8601 instant.

granularity
enum<string>
default:week

Cohort bucket and period unit. Weeks start Monday.

Available options:
day,
week,
month
max_periods
integer
default:12

Highest period index returned, counted in granularity units from period 0.

Required range: 1 <= x <= 24

Response

Successful response. Activity retention: a person counts as retained for any activity in the period, not for a specific event.

cohorts
object[]
required

One entry per cohort, oldest first. Empty when no cohort falls in the range.

granularity
enum<string>
required
Available options:
day,
week,
month
date_range
object
required
complete
boolean
required

Always true on a 200. A failed read is a 503, never an empty cohort grid.

meta
object