SaaSFlow
DevelopersAPIReferencereports

Create report

Start generating a performance report for one month. This returns as soon as the agent run is queued, giving back a reportId to poll and a runId for…

Authentication

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

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
reportMonth*string

The calendar month the report covers, as YYYY-MM.

Match^\d{4}-(0[1-9]|1[0-2])$

Response Body

Report generation started

application/json
  1. response
reportId*string
runId*string
curl -X POST 'https://api.saasflow.com/companies/string/reports' \  -H 'Content-Type: application/json' \  -d '{  "reportMonth": "string"}'
{  "reportId": "string",  "runId": "string"}

List reports

List a company's performance reports, newest first. The rendered document is left out here to keep the list light, so read a single report to get it.

Retrieve report

Retrieve one report, including its rendered document once generation has finished. Poll this after starting a report: until it is ready the document is…