About this endpoint
What it does
Validates and extracts structured data from a webpage URL. It returns the source URL along with any discovered JSON-LD, meta tags, microdata, Open Graph data, Twitter card data, and a summary object.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to extract, audit, or validate content from (http/https only). Must be a URI. |
Response
Returns a JSON object with url and source_url string fields, json_ld and microdata array fields, summary as an object, and meta_tags, open_graph, and twitter_card object fields. The response shape is defined by the schema; no additional fields are specified.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | String value returned by the API. |
| json_ld | Object Array | No | Array of JSON-LD objects. Each item is an object; additional properties are allowed. |
| summary | Object | No | Summary object containing the schema-defined fields: 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 | Object containing meta tag data. Additional properties are allowed. |
| microdata | Object Array | No | Array of microdata objects. Each item is an object; additional properties are allowed. |
| open_graph | Object | No | Object containing Open Graph data. Additional properties are allowed. |
| source_url | String | No | String value returned by the API. |
| twitter_card | Object | No | Object containing Twitter card data. Additional properties are allowed. |