Analytics
Use this when the user asks for summary SaaS metrics (MRR, ARR, NRR, GRR, churn, LTV, CAC, burn rate, runway) over a period.
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
metricNames*array<>startDate*string^\d{4}-\d{2}$endDate*string^\d{4}-\d{2}$mrrType*stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
"cmrr""mrr"timeZone?stringIANA time zone. Defaults to BatchContext.timeZone, then UTC.
smoothingMonths?integer1 <= value <= 121productIds?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.
nullanalytics result
application/json- response
[key: string]?curl -X POST 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/data/analytics' \ -H 'Content-Type: application/json' \ -d '{ "metricNames": [ "mrr" ], "startDate": "string", "endDate": "string", "mrrType": "cmrr"}'{ "property1": { "title": "string", "subTitle": "string", "format": "string", "values": { "property1": 0, "property2": 0 }, "rawValues": { "property1": 0, "property2": 0 } }, "property2": { "title": "string", "subTitle": "string", "format": "string", "values": { "property1": 0, "property2": 0 }, "rawValues": { "property1": 0, "property2": 0 } }}MrrByProduct
Use this when the user asks how MRR is distributed across products or plans. Requires permissions: subscriptions:read.
MetricDefinitions
Use this when the user asks how a SaaS metric is defined or calculated (formula, inputs, windows, caps). Static definitions only; use the analytics slice…