Cohorts
Use this when the user asks about customer retention or revenue retention by cohort. Returns the cohort matrix only (one entry per cohort month, MRR and…
Authentication
Authorization<token>A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
companyId*stringuuidapplication/json- body
mrrType*stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
"cmrr""mrr"startDate?string^\d{4}-\d{2}$endDate?string^\d{4}-\d{2}$productIds?array<string>|Restrict subscription metrics to these product ids. Omit or null for all products. Values are unioned; a customer on several selected products counts once.
nullcohorts result
application/json- response
One entry per cohort, keyed by the month its customers first carried MRR. For the customers behind a single cohort/month cell, use the cohortCustomers slice.
[key: string]?curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/cohorts' \ -H 'Content-Type: application/json' \ -d '{ "mrrType": "cmrr"}'{ "property1": { "mrr": { "property1": 0, "property2": 0 }, "customerCount": { "property1": 0, "property2": 0 } }, "property2": { "mrr": { "property1": 0, "property2": 0 }, "customerCount": { "property1": 0, "property2": 0 } }}PeriodDetails
Use this when the user asks for the detailed breakdown of a single period (transactions, categorizations, totals). Requires permissions: transactions:read.
CohortCustomers
Use this when the user asks which customers make up one cohort, or what is behind a single cell of the cohorts matrix.