API
API overview
Trigger audits, poll status, and export reports programmatically — built for agencies managing multiple stores.
Status
The Surfacely REST API is coming soon. Today, audits are triggered through the web dashboard and completed via our background job pipeline. This page describes the planned surface so you can plan integrations ahead of launch.
Who it is for
- Agencies running GEO audits across dozens of client stores on a schedule.
- Internal tooling teams embedding audit triggers in onboarding flows.
- Partners building dashboards that combine Surfacely scores with other data.
Planned API surface
- POST /audits
- Trigger a new audit for a domain. Returns an audit ID and queued status.
- GET /audits/{id}
- Poll audit status (queued, running, complete, failed) and retrieve summary scores when ready.
- GET /audits/{id}/report
- Export structured JSON for scores, issues, recommendations, and AI visibility results.
- Webhooks
- Optional callbacks on audit complete and monitoring run complete for async workflows.
- Authentication
- Bearer API keys scoped to your organization, rotatable from the dashboard.
Request early access
Agency tier customers can join the API waitlist. Tell us your expected audit volume, integration target, and timeline.