About this endpoint
What it does
Validates structured data found on a webpage URL and returns the extracted metadata and a validation summary. The request body requires a url field, and the response includes the source URL plus structured-data-related fields when available.
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 and use http or https. |
Response
Returns a JSON object with top-level fields for the analyzed page URL, structured data extracts, and a summary object. The response includes url and source_url strings, json_ld and microdata arrays of objects, meta_tags, open_graph, and twitter_card objects, and a summary object with validation metrics.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The analyzed page URL. |
| json_ld | Object Array | No | JSON-LD objects extracted from the page. |
| summary | Object | No | Validation summary object containing scoring and counts. |
| summary.warnings | Integer | No | Number of warnings found. |
| summary.types_found | String Array | No | Types detected in the structured data. |
| summary.overall_score | Number | No | Overall score for the page's structured data. |
| summary.total_entities | Integer | No | Total number of detected entities. |
| summary.critical_errors | Integer | No | Number of critical errors found. |
| summary.rich_results_eligible | String Array | No | Rich result types the page is eligible for. |
| meta_tags | Object | No | Meta tag data extracted from the page. Additional properties may be present. |
| microdata | Object Array | No | Microdata objects extracted from the page. |
| open_graph | Object | No | Open Graph data extracted from the page. Additional properties may be present. |
| source_url | String | No | Source URL associated with the extracted data. |
| twitter_card | Object | No | Twitter Card data extracted from the page. Additional properties may be present. |