About this endpoint
What it does
Evaluates the SEO health of a webpage given its url and returns an SEO report for that page, including a score, grade, breakdown metrics, top fixes, and related URLs.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to evaluate. Must be a valid URI using http/https only. |
Response
Returns a JSON object with url, grade, score, breakdown, top_fixes, and source_url fields. breakdown is a nested object with SEO metric counts and booleans, and top_fixes is an array of strings.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The evaluated webpage URL. |
| grade | String | No | The SEO grade assigned to the webpage. |
| score | Integer | No | The SEO score assigned to the webpage. |
| breakdown | Object | No | SEO metric summary object containing warnings, json_ld_count, has_open_graph, critical_errors, microdata_count, has_twitter_card, rich_results_total, rich_results_eligible, and structured_data_present. |
| top_fixes | String Array | No | Array of suggested fixes. |
| source_url | String | No | Source URL for the report. Must be a valid URI. |