Skip to Content
SaaSFlow
DevelopersAPIReferencedata

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

Checking whether you're signed in…
POST
/companies/{companyId}/data/cohorts

Authorization

headerAuthorization<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.

Path Parameters

companyId*string
Formatuuid

Request Body

application/json
  1. body
mrrType*string

MRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.

Value in"cmrr""mrr"
startDate?string
Match^\d{4}-\d{2}$
endDate?string
Match^\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.

Defaultnull

Response Body

cohorts result

application/json
  1. 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]?
Example Request
curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/cohorts' \  -H 'Content-Type: application/json' \  -d '{  "mrrType": "cmrr"}'
Example Response
{  "property1": {    "mrr": {      "property1": 0,      "property2": 0    },    "customerCount": {      "property1": 0,      "property2": 0    }  },  "property2": {    "mrr": {      "property1": 0,      "property2": 0    },    "customerCount": {      "property1": 0,      "property2": 0    }  }}