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…
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*string1 <= lengthapplication/json- body
metricNames?array<>Metrics to return definitions for. Omit for all metrics, which needs both subscriptions:read and financials:read; name only subscription metrics (MRR, churn, retention) and subscriptions:read is enough.
mrrType?stringMRR variant. cmrr = committed MRR (CMRR), mrr = recognised MRR.
"cmrr""mrr"metricDefinitions result
application/json- response
[key: string]?curl -X POST 'https://api.saasflow.com/companies/string/data/metricDefinitions' \ -H 'Content-Type: application/json' \ -d '{}'{ "property1": { "title": "string", "subTitle": "string", "format": "number", "category": "Recurring revenue", "description": "string", "formula": { "kind": "metric", "name": "mrr", "monthOffset": 0 }, "notes": [ "string" ], "requires": "string" }, "property2": { "title": "string", "subTitle": "string", "format": "number", "category": "Recurring revenue", "description": "string", "formula": { "kind": "metric", "name": "mrr", "monthOffset": 0 }, "notes": [ "string" ], "requires": "string" }}Analytics
Use this when the user asks for summary SaaS metrics (MRR, ARR, NRR, GRR, churn, LTV, CAC, burn rate, runway) over a period.
MetricExplanation
Use this when the user asks why a metric has its value or how it was computed for a specific month: returns the formula with every part resolved to its…