About this endpoint
What it does
Audits 2 to 5 URLs in one call and compares them: overall score, each category, AI readability and the top fixes for each page. Useful for checking a page against competitors or comparing versions of a page.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| urls | String Array | Yes | The URLs to compare side by side. Provide at least 2 and at most 5 items. |
Response
A JSON object; nested fields are written parent.child, and [] marks an array of objects.
| Field | Type | Description |
|---|---|---|
diff | object | How the URLs compare: the leader in each category and the gap between every pair. |
diff.pairs | array of object | One entry per pair of URLs compared. |
diff.pairs[].a | string | First URL of the pair. |
diff.pairs[].b | string | Second URL of the pair. |
diff.pairs[].overall_gap | number | a's overall score minus b's, in points; negative means b scores higher. |
diff.pairs[].category_diffs | array of object | One item per category where the two URLs score differently; empty when they score the same in every category. |
diff.pairs[].category_diffs[].category | string | The category — meta, technical, social, performance or accessibility. |
diff.pairs[].category_diffs[].winner | string | The URL with the higher score in this category. |
diff.pairs[].category_diffs[].gap | number | How many points the winner leads by (always positive). |
diff.overall_leader | object | URL with the highest overall score. |
diff.overall_leader.url | string | The leading URL. |
diff.overall_leader.score | number | Its score, 0–100. |
diff.category_leaders | object | Best URL per category. |
diff.category_leaders.meta | object | Leader for this category. |
diff.category_leaders.meta.leader | string | URL with the highest score in this category. |
diff.category_leaders.meta.score | number | That URL's category score, 0–100. |
diff.category_leaders.social | object | Leader for this category. |
diff.category_leaders.social.leader | string | URL with the highest score in this category. |
diff.category_leaders.social.score | number | That URL's category score, 0–100. |
diff.category_leaders.technical | object | Leader for this category. |
diff.category_leaders.technical.leader | string | URL with the highest score in this category. |
diff.category_leaders.technical.score | number | That URL's category score, 0–100. |
diff.category_leaders.performance | object | Leader for this category. |
diff.category_leaders.performance.leader | string | URL with the highest score in this category. |
diff.category_leaders.performance.score | number | That URL's category score, 0–100. |
diff.category_leaders.accessibility | object | Leader for this category. |
diff.category_leaders.accessibility.leader | string | URL with the highest score in this category. |
diff.category_leaders.accessibility.score | number | That URL's category score, 0–100. |
diff.ai_readability_leader | object | URL with the highest AI readability score. |
diff.ai_readability_leader.url | string | The leading URL. |
diff.ai_readability_leader.score | integer | Its score, 0–100. |
count | integer | Number of URLs in the request. |
results | array of object | One result per URL, in the order sent. |
results[].url | string | The URL that was checked, as you sent it. |
results[].grade | string | Letter grade from A+ to F. |
results[].score | number | Score, 0–100. |
results[].categories | object | Score per audit category (meta, technical, social, performance, accessibility), each 0–100. |
results[].categories.meta | number | Category score, 0–100. |
results[].categories.technical | number | Category score, 0–100. |
results[].categories.social | number | Category score, 0–100. |
results[].categories.performance | number | Category score, 0–100. |
results[].categories.accessibility | number | Category score, 0–100. |
results[].priorities | array of object | Fix list, most important first. |
results[].priorities[].severity | string | How much fixing it matters — high, medium or low. |
results[].priorities[].category | string | Category the issue belongs to (e.g. meta, technical, performance). |
results[].priorities[].issue | string | The problem found, in a short phrase. |
results[].priorities[].fix | string | The change to make. |
results[].priorities[].plain_english | string | Why it matters, in plain language for a non-specialist. |
results[].priorities[].who_fixes_it | string | Who usually makes the fix — e.g. content (copywriter/editor), developer, marketing. |
results[].ai_readability | integer | AI readability score for this URL, 0–100. |
compared | integer | Number of URLs successfully audited and compared. |