Skip to content
Execution

SEO audits

Technical SEO audits covering crawlability, on-page, performance, structured data, mobile and security.

POST/api/v1/auditsRead & write key

Start an audit

Authentication: Bearer API key in the Authorization header.

Parameters
ParameterInTypeDescription
url*bodystringPage to audit
websiteIdbodystringAttach to a website (auto-detected otherwise)
Request
curl -X POST "https://rankspire.tech/api/v1/audits" \
  -H "Authorization: Bearer $RANKSPIRE_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://example.com" }'
Response
{ "data": { "id": "cm1aud…", "status": "queued", "jobId": "cm1job…" } }
  • 422 validation_error private or invalid URL, or three audits already running
GET/api/v1/audits/{id}Read key

Audit status, scores and issues

Authentication: Bearer API key in the Authorization header.

Request
curl "https://rankspire.tech/api/v1/audits/cm1site9x0001" \
  -H "Authorization: Bearer $RANKSPIRE_KEY"
Response
{
  "data": { "status": "completed", "score": 73, "categoryScores": { "technical": 70, "onpage": 82, ... },
            "issues": [{ "severity": "critical", "category": "technical", "title": "Missing canonical tag", "recommendation": "Add a self-referencing canonical." }] }
}