SaaSFlow
DevelopersAPIReferencereports

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…

Authentication

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

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
id*string
Length1 <= length

Response Body

The report, including the document once ready.

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
definitionId*string

The agent definition (registry key) that produces this report.

reportMonth*string

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

status*string

The current lifecycle status of the report.

Value in"generating""ready""failed"
runId*|

The agent run that generated this report, if any.

Formatuuid
title*|

The report title, available once the report is ready.

summary*|

A short plain-text abstract of the report, available once ready.

error*|

Failure reason if generation failed.

document*|

The full generated report document. Null until the report is ready.

createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
curl -X GET 'https://api.saasflow.com/companies/string/reports/string'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "definitionId": "string",  "reportMonth": "string",  "status": "generating",  "runId": "78c33d18-170c-44d3-a227-b3194f134f73",  "title": "string",  "summary": "string",  "error": "string",  "document": {    "schemaVersion": 1,    "title": "string",    "period": {      "month": "string"    },    "facts": {      "mrrBasis": "cmrr",      "timeZone": "string",      "endMrr": 0,      "priorEndMrr": 0,      "mrrGrowthPct": 0,      "endCustomerCount": 0,      "newMrr": 0,      "churnedMrr": 0    },    "summary": "string",    "html": "string"  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

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…

Update report

Rename a report. Only the display title changes; the document and its numbers are untouched. A report that is still generating cannot be renamed and…