API
Automate SEO audits with a clean, versioned REST API
Create audits, retrieve scores and detailed report payloads, list websites, and pull report artifacts programmatically using JWT or API-key authenticated endpoints.
Built for automation without mystery
If your team already runs CI checks, internal dashboards, or client portals, Electro SEO’s API lets SEO health join those workflows.
Typical integrations queue an audit after deploy, store the overall score in a release record, and open a ticket when critical recommendations appear. Agencies also use the API to provision sites and sync report status into their own client hubs.
Core resources
Endpoints are versioned under /api/v1 and protected by authentication. Exact schemas are documented in the live Swagger/OpenAPI surface of your environment.
POST /audits
Create an audit for a URL (and optional websiteId). Returns scores, issues, and the detailed report object when processing completes synchronously in current deployments.
GET /audits and GET /audits/:id
List audits with pagination/search/website filters, or fetch a single audit including issues and rich report sections.
Websites endpoints
Create and manage website properties, fetch enriched detail (stats, recent audits, verification), and update notes/status.
Verification endpoints
Start and check website ownership verification flows (meta tag, DNS, or file) for stronger property control.
Reports endpoints
List and retrieve generated report artifacts associated with audits for downstream delivery systems.
Auth & API keys
Use login/JWT bearer tokens for interactive apps, or API keys on eligible plans for server-to-server automation.
Implementation tips
A few practices that keep integrations reliable.
- Store audit IDs and website IDs as first-class references in your system of record
- Treat recommendations as advisory; never auto-publish site changes without human review
- Respect rate limits and fair-use crawl constraints
- Log request IDs/timestamps to speed up support if something fails