Run a cohort-retention report
Computes a cohort-retention matrix over your CDP event stream: subjects are bucketed into daily or weekly cohorts by when they first fired cohort_event, then Orbit measures how many returned to fire return_event in each subsequent period out to periods. Each cohort row carries its size (the denominator) and a retained-count and retention-rate vector where period 0 is the entry bucket. Use it to see how retention decays over time and to compare acquisition cohorts. Owner / admin / developer with the contacts:read scope only.
Authorizations
Dashboard JWT token from Clerk
Response
Cohort-retention matrix: one row per entry cohort with its size and a retained[] / retention_rate[] vector of length periods+1 (period 0 is the entry bucket).
The response is of type object.