About this endpoint
What it does
Audits a webpage from the provided URL and returns a structured report with metadata, detected tech stack, performance metrics, broken links, security header presence, and a mobile-friendly flag.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to extract, audit, or validate content from (http/https only). Format: URI. |
Response
Returns a JSON object with these top-level fields: url string, meta_tags object, source_url string, tech_stack array of strings, performance object, broken_links array of URI strings, security_headers object, and is_mobile_friendly boolean.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | URI of the audited page. |
| meta_tags | Object | No | Page metadata fields. Includes title string, og_image URI string, og_title string, canonical URI string, description string, twitter_card string, and og_description string. |
| meta_tags.title | String | No | Page title. |
| meta_tags.og_image | String | No | Open Graph image URI. |
| meta_tags.og_title | String | No | Open Graph title. |
| meta_tags.canonical | String | No | Canonical URI. |
| meta_tags.description | String | No | Meta description. |
| meta_tags.twitter_card | String | No | Twitter card value. |
| meta_tags.og_description | String | No | Open Graph description. |
| source_url | String | No | URI for the source page used in the audit. |
| tech_stack | String Array | No | Detected technology stack items. |
| performance | Object | No | Performance metrics. Includes load_time_ms integer, num_requests integer, page_size_bytes integer, and page_size_readable string. |
| performance.load_time_ms | Integer | No | Page load time in milliseconds. |
| performance.num_requests | Integer | No | Number of requests made. |
| performance.page_size_bytes | Integer | No | Page size in bytes. |
| performance.page_size_readable | String | No | Human-readable page size. |
| broken_links | String Array | No | Broken link URIs found on the page. |
| security_headers | Object | No | Security header audit data. Includes score string, details object, has_csp boolean, has_hsts boolean, has_x_content_type boolean, has_referrer_policy boolean, and has_x_frame_options boolean. |
| security_headers.score | String | No | Security headers score. |
| security_headers.details | Object | No | Additional security header details as key-value string pairs. |
| security_headers.has_csp | Boolean | No | Whether a Content Security Policy header is present. |
| security_headers.has_hsts | Boolean | No | Whether an HSTS header is present. |
| security_headers.has_x_content_type | Boolean | No | Whether an X-Content-Type-Options header is present. |
| security_headers.has_referrer_policy | Boolean | No | Whether a Referrer-Policy header is present. |
| security_headers.has_x_frame_options | Boolean | No | Whether an X-Frame-Options header is present. |
| is_mobile_friendly | Boolean | No | Whether the page is mobile friendly. |