Skip to main content

Report types

ORCA generates three types of PDF reports:

Generating a report

From the UI

  1. Navigate to Reports in the sidebar.
  2. Select a report type and configure options (file scope, date range).
  3. Click Generate. The report is queued for async processing.
  4. Once complete, download the PDF or share it via link.

From the API

The response includes a report job ID. Poll the status endpoint until status is "complete":

Downloading a report

Once the report status is complete, download the PDF:
The endpoint returns a 307 redirect to a time-limited S3 presigned URL. The download URL is scoped to your organisation — cross-tenant access is blocked.

Report scheduling

Admins can schedule recurring report generation with automatic email delivery.

Create a schedule

Manage schedules

  • List schedules: GET /api/v1/reports/schedules
  • Update a schedule: PATCH /api/v1/reports/schedules/{schedule_id}
  • Delete a schedule: DELETE /api/v1/reports/schedules/{schedule_id}
Schedule management requires the admin role.

Public report sharing

AI Readiness reports can be shared externally via a tokenized public link. Recipients can view the report without logging in.
The share token is unique and non-guessable. Public reports are read-only and do not expose raw data — only scores, grades, and recommendations.

Report verification

AI Readiness certificates include a SHA-256 verification hash. Anyone with the hash can verify that the certificate has not been tampered with by checking it against the ORCA verification endpoint:
This returns the certificate details if the hash matches, confirming the report is authentic and unmodified.

API reference