A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "rsch_1f8a",
"dashboardId": "dsh_9a12",
"name": "Weekly billing digest",
"cadence": "weekly",
"hourLocal": 7,
"tz": "America/New_York",
"recipients": [
"owner@acme.com"
],
"formats": [
"pdf",
"link"
],
"delivery": "email",
"enabled": true,
"lastSentAt": "2026-07-07T11:00:00.000Z",
"createdAt": "2026-06-01T00:00:00.000Z",
"updatedAt": "2026-07-07T11:00:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Get a scheduled report
The full schedule document. 404 if absent/cross-org.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "rsch_1f8a",
"dashboardId": "dsh_9a12",
"name": "Weekly billing digest",
"cadence": "weekly",
"hourLocal": 7,
"tz": "America/New_York",
"recipients": [
"owner@acme.com"
],
"formats": [
"pdf",
"link"
],
"delivery": "email",
"enabled": true,
"lastSentAt": "2026-07-07T11:00:00.000Z",
"createdAt": "2026-06-01T00:00:00.000Z",
"updatedAt": "2026-07-07T11:00:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
Path Parameters
The report-schedule id (from listReportSchedules / createReportSchedule).
Response
The schedule document.
A scheduled report: "email the digest every at ". The analytics worker sweeps enabled schedules, composes each digest via the SAME metric-registry compile path the live dashboard uses (so the emailed numbers equal the on-screen numbers), and delivers a clean HTML email (link always; CSV attached when requested; PDF of the real charts attached when requested and a renderer is available) through Resend. lastSentAt is empty until the first successful send.
Show child attributes
Show child attributes
Show child attributes
Show child attributes