Skip to content

API Reference

Fabrizio Degni edited this page Jul 8, 2026 · 1 revision

API Reference

This page summarizes the main PolicyWatcher API surfaces. Exact responses may evolve across releases.

Public APIs

Route Method Purpose
/api/companies GET Public company and policy data, evidence gated
/api/changes GET Public policy changes
/api/policies/[id] GET Policy detail and version history
/api/timeline GET Timeline data where available
/api/matrix GET Public KPI matrix, withholding unassessed placeholders
/api/leaderboard GET Policy Signals Board data
/api/source-suspensions GET Public source-suspension metadata
/api/report/[policyId] GET Executive PDF report
/api/og/change/[id] GET Open Graph image for share pages

Protected Operational APIs

Route Method Auth
/api/cron/check-all POST Bearer API_SECRET
/api/cron/weekly POST Bearer API_SECRET
/api/cron/monthly POST Bearer API_SECRET
/api/scrape POST Bearer API_SECRET
/api/health GET Public/basic or bearer-enhanced depending on use

Admin APIs

Admin APIs require a valid admin session cookie.

Route Purpose
/api/admin/auth Login/session operations
/api/admin/metrics Admin system/database metrics
/api/admin/dataset-quality Dataset QA checks and issue actions
/api/admin/access-logs Admin access-log inspection/export
/api/admin/vps-services Renderer and operations-agent checks
/api/admin/companies Company/policy registry operations
/api/admin/policies Policy management

Error Handling

Newer operational endpoints should avoid exposing raw internal exception strings. Persistent logs, client responses and admin progress output should use sanitized reason tokens and correlation references where possible.

Clone this wiki locally