SaaSFlow
DevelopersAPIReferencedata

RetentionCohortDetail

Use this when the user asks for the customer-level detail behind a specific retention cohort cell. It returns one row per customer in that month, which is…

Authentication

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

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
Length1 <= length

Request Body

application/json
  1. body
month*string
Match^\d{4}-\d{2}$
horizon?string
Value in"monthly""annual"
mrrType*string

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

Value in"cmrr""mrr"
timeZone?string

IANA time zone. Defaults to BatchContext.timeZone, then UTC.

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

retentionCohortDetail result

application/json
  1. response
[index: integer]?
curl -X POST "https://example.com/companies/string/data/retentionCohortDetail" \  -H "Content-Type: application/json" \  -d '{    "month": "string",    "mrrType": "cmrr"  }'
[  {    "customerId": "string",    "customerName": "string",    "mrrStart": 0,    "mrrEnd": 0  }]

CustomerChanges

Use this when the user asks which customers changed (new/upgraded/downgraded/churned) in a period. Requires permissions: subscriptions:read…

List search

Free-text search across a company, grouped by entity type. Use it when you know a name but not an id: one call matches customers, vendors, and accounts on…