Skip to content

Scheduled Reports ​

Scheduled reports let organization administrators automate delivery of generated PDF reports to a fixed list of email recipients. Use them for recurring compliance, HIPAA, or audit reporting without manual export each period.

Report types ​

When creating or updating a schedule, report_type must be one of:

ValueTypical use
complianceGeneral compliance report (PDF generated via the compliance export path).
hipaaHIPAA-focused compliance report.
auditAudit log export as PDF.

Invalid types are rejected with 400.

Scheduling: weekly vs monthly ​

  • schedule: weekly or monthly.
  • Weekly — Set day_of_week (required): 0 = Monday through 6 = Sunday. The system computes the next run (default cadence targets early-morning UTC).
  • Monthly — Set day_of_month (required): 1–28 (upper bound avoids variable month lengths).

If you choose weekly without day_of_week, or monthly without day_of_month, the API returns 400 with a clear validation message.

Recipients ​

Each scheduled report has a recipients array of email addresses. The backend sends the generated PDF to each recipient when the job runs.

Validation

Recipients must not be empty. Create and update payloads enforce min_items=1: at least one email must be present whenever recipients are supplied. Updates that include recipients must still include at least one address.

Send now ​

Administrators can trigger an immediate send without waiting for the next scheduled run:

  • POST /api/admin/scheduled-reports/{report_id}/send-now

The response indicates success, a short message, and sent_to (recipients that were actually emailed). Sending updates last_sent and recalculates next_run for recurring schedules.

Managing schedules (CRUD) ​

All routes require admin authentication and are scoped to the administrator’s organization.

MethodPathPurpose
GET/api/admin/scheduled-reportsList all scheduled reports for the org.
POST/api/admin/scheduled-reportsCreate a new schedule.
GET/api/admin/scheduled-reports/{report_id}Fetch one report by ID.
PUT/api/admin/scheduled-reports/{report_id}Update fields (type, schedule, days, recipients, enabled, etc.).
DELETE/api/admin/scheduled-reports/{report_id}Remove a schedule.

Responses include metadata such as enabled, last_sent, next_run, and audit-friendly created_at / updated_at where applicable.

Operational notes ​

  • Organization isolation — Reports are visible only within the same organization_id as the admin; cross-tenant access returns 403.
  • Enabling/disabling — Use updates to toggle enabled without deleting the configuration.
  • Email delivery — Actual delivery depends on your deployment’s email service configuration.

SOC 2 Type II Certified | BAA Available | HIPAA-Ready