About this endpoint
What it does
Audits a webpage given its URL and returns a structured report about the page’s URL, meta tags, detected tech stack, performance metrics, broken links, security headers, and mobile-friendliness.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | URL of the webpage to extract, audit, or validate content from. Must be a valid http/https URI. |
Response
Returns a JSON object with the top-level fields url (String), meta_tags (Object), source_url (String), tech_stack (String Array), performance (Object), broken_links (String Array), security_headers (Object), and is_mobile_friendly (Boolean).
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | URL of the audited page. |
| meta_tags | Object | No | Meta tag information for the page, including title, og_image, og_title, canonical, description, twitter_card, and og_description. |
| meta_tags.title | String | No | Page title. |
| meta_tags.og_image | String | No | Open Graph image URL. Must be a valid URI. |
| meta_tags.og_title | String | No | Open Graph title. |
| meta_tags.canonical | String | No | Canonical URL. Must be a valid 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 | Source URL of the audited content. Must be a valid URI. |
| tech_stack | String Array | No | Detected technologies used by the page. |
| performance | Object | No | Performance metrics for the page, including load_time_ms, num_requests, page_size_bytes, and page_size_readable. |
| 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 page links. Each item is a URI. |
| security_headers | Object | No | Security header assessment, including score, details, has_csp, has_hsts, has_x_content_type, has_referrer_policy, and has_x_frame_options. |
| security_headers.score | String | No | Security header score. |
| security_headers.details | Object | No | Additional security header details. |
| security_headers.has_csp | Boolean | No | Whether Content Security Policy is present. |
| security_headers.has_hsts | Boolean | No | Whether HTTP Strict Transport Security is present. |
| security_headers.has_x_content_type | Boolean | No | Whether X-Content-Type-Options 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 X-Frame-Options is present. |
| is_mobile_friendly | Boolean | No | Whether the page is mobile-friendly. |