Skip to content
Overwatch API

Stakeholder reports

Reports for editors live in the API; reports for stakeholders — a client, a manager, a compliance owner — are a different artifact. Overwatch assembles a branded, verdict-first PDF report per site, spanning every installed app: broken links, accessibility, uptime, and Core Web Vitals.

The report leads with plain-language verdicts and trends rather than raw issue lists, and it is branded with the organization’s name and logo — for an agency, that means a handover document that looks like yours, not ours.

On demand

Section titled “On demand”

GET /v1/sites/{id}/report.pdf renders and returns the PDF in one call — org-scoped like every other route, so both dashboard sessions and CMS API keys can fetch it:

Terminal window
curl -o example.com-health.pdf \
  https://api.overwatch.weareheavy.dev/v1/sites/<site-id>/report.pdf \
  -H "x-api-key: wah_…"

The response is application/pdf with a content-disposition filename of the form <hostname>-health-<date>.pdf. Rendering involves a headless browser, so a 502 means “try again”, not a permanent failure.

On a schedule

Section titled “On a schedule”

Add reportRecipients in notification settings — org-wide or per site — and the report is emailed as a PDF attachment on a weekly schedule. Per-site recipients let an agency send each client only their own site’s report.