About this endpoint
What it does
Evaluates the SEO health of a webpage from the submitted URL and returns an assessment object with a grade, score, breakdown metrics, top fixes, and source URL.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to extract, audit, or validate content from. Must be a valid URI using http or https. |
Response
Returns a JSON object with url, grade, score, breakdown, top_fixes, and source_url fields. breakdown is an object with several SEO-related metrics, top_fixes is an array of strings, and the other top-level fields are scalar values.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The URL that was evaluated. Format: URI. |
| grade | String | No | The SEO grade returned by the service. |
| score | Integer | No | The SEO score returned by the service. |
| breakdown | Object | No | SEO breakdown metrics 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 | List of top fixes returned by the service. |
| source_url | String | No | Source URL returned by the service. Format: URI. |