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

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.

In: header

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/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.