SaaSFlow
DevelopersAPIReferencedata

CohortCustomers

Run the cohortCustomers aggregation. Requires permissions: subscriptions:read, customers:read.

Authentication

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

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/cohortCustomers" \  -H "Content-Type: application/json" \  -d '{    "cohortMonth": "string",    "targetMonth": "string",    "mrrType": "cmrr"  }'
[  {    "customerId": "string",    "customerName": "string",    "mrr": 0  }]

Cohorts

Use this when the user asks about customer retention or revenue retention by cohort. Requires permissions: subscriptions:read, customers:read.

CustomerMonthlyData

Use this when the user asks for one customer's month-by-month metrics or activity. For per-customer MRR in a month, request dataType "end" (MRR at month…