Skip to main content
Audit

On-page SEO audit for a URL

View Markdown

Runs an instant on-page SEO audit of a single URL and returns its on-page score, the specific issues found (missing title, no H1, broken links, render-blocking resources, and more), meta summary, and load timing. Costs 2 credits.

POST/v1/audit/

Authorization

accessKey
x-access-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/audit/" \  -H "Content-Type: application/json" \  -d '{    "url": "string"  }'
{
  "success": true,
  "credits": {
    "charged": 0,
    "remaining": 0
  },
  "data": {
    "url": "string",
    "status_code": null,
    "onpage_score": 0,
    "issues": [
      "string"
    ],
    "meta": {},
    "page_timing": {}
  }
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}
{
  "success": false,
  "message": "string"
}