Analytics

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.

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.

metricNames*array<string>

startDate*string

Match^\d{4}-\d{2}-\d{2}

endDate*string

Match^\d{4}-\d{2}-\d{2}

mrrType*string

MRR variant. cmrr = contract MRR, mrr = recognised MRR.

Value in"cmrr" | "mrr"

timeZone?string

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

Response Body

`application/json`

curl -X POST "https://api.saasflow.com/companies/string/data/analytics" \  -H "Content-Type: application/json" \  -d '{    "metricNames": [      "string"    ],    "startDate": "string",    "endDate": "string",    "mrrType": "cmrr"  }'

{
  "property1": {
    "title": "string",
    "subTitle": "string",
    "format": "string",
    "values": {
      "property1": 0,
      "property2": 0
    }
  },
  "property2": {
    "title": "string",
    "subTitle": "string",
    "format": "string",
    "values": {
      "property1": 0,
      "property2": 0
    }
  }
}

null

null

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

403application/json

`application/json`

`application/json`

`application/json`