Documentation
API documentation
Agency plan accounts can use the ClarityCrawl API to create audits, fetch reports, export findings, and connect page intelligence into client portals, CI workflows, and internal dashboards.
Available surfaces
- Authentication and Agency API keys.
- Report creation for live URLs.
- Report details, findings, public sharing, alerts, and exports.
- Batch audits, report comparison, schema generation, and billing usage.
Common workflow
On Agency, generate an API key in Settings, create a report with a target URL and optional template metadata, poll the report until completion, then export PDF, CSV, JSON, or operational findings for your delivery workflow.