About this endpoint
What it does
Validates the HTML you submit in the request body for structured data-related content and returns a JSON object describing what was found. The response includes the source URL, detected JSON-LD, microdata, metadata-related objects, and a summary of validation results.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| html | String | Yes | Raw HTML content to validate for structured data. Maximum length: 5,000,000 characters. |
Response
Returns a JSON object with url and source_url string fields, json_ld and microdata object arrays, summary as an object, and meta_tags, open_graph, and twitter_card as objects. The summary object contains warnings, overall_score, total_entities, and critical_errors numeric fields, plus types_found and rich_results_eligible string arrays.
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The URL associated with the validated HTML. |
| json_ld | Object Array | No | JSON-LD items found in the HTML. Each array item is an object that may contain additional properties. |
| summary | Object | No | Validation summary object. Contains warnings (integer), types_found (string array), overall_score (number), total_entities (integer), critical_errors (integer), and rich_results_eligible (string array). |
| meta_tags | Object | No | Meta tag data extracted from the HTML. Additional properties are allowed. |
| microdata | Object Array | No | Microdata items found in the HTML. Each array item is an object that may contain additional properties. |
| open_graph | Object | No | Open Graph data extracted from the HTML. Additional properties are allowed. |
| source_url | String | No | The source URL associated with the HTML, if available. |
| twitter_card | Object | No | Twitter card data extracted from the HTML. Additional properties are allowed. |