About this endpoint
What it does
Audits a single page for image SEO and alt-text issues. It takes a page url and optional lang, then returns the audited page metadata, image findings, score, grade, and supporting breakdown fields.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| url | String | Yes | Page URL to audit. Must be a URI and up to 2048 characters. |
| lang | ENUM | No | Page language context for the audit. Allowed values: auto, en, fr, ar. Default: auto. |
Response
Returns a JSON object with top-level fields for the audited url (string), page (object), grade (ENUM), score (integer), images (object), language (ENUM), final_url (string), audited_at (string), robots_txt (object), and score_breakdown (array). The response shape is nested, and the page and images objects contain the detailed audit data.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| url | String | No | The audited page URL. |
| page | Object | No | Page-level audit data, including h1, title, issues, json_ld, h1_count, canonical, html_lang, open_graph, robots_meta, and meta_description. |
| page.h1 | String | No | The page's H1 text. |
| page.title | String | No | The page title. |
| page.issues | String Array | No | Page-level issues found during the audit. |
| page.json_ld | Object | No | JSON-LD data found on the page. |
| page.h1_count | Integer | No | Number of H1 elements found. |
| page.canonical | String | No | Canonical URL, or null. |
| page.html_lang | String | No | HTML language code, or null. |
| page.open_graph | Object | No | Open Graph metadata found on the page. |
| page.robots_meta | String | No | Robots meta content, or null. |
| page.meta_description | String | No | Meta description content, or null. |
| grade | ENUM | No | Audit grade. Allowed values: A, B, C, D, F. |
| score | Integer | No | Audit score from 0 to 100. |
| images | Object | No | Image audit data, including the image list and aggregate counts. |
| images.list | Object Array | No | List of audited images. Each item includes src, format, position, alt_issues, confidence, current_alt, lazy_loaded, suggestions, file_size_kb, size_checked, speed_issues, suggested_alt, and has_dimensions. |
| images.list[].src | String | No | Image source URL. |
| images.list[].format | ENUM | No | Image format classification. Allowed values: modern, legacy, negotiated, unknown. |
| images.list[].position | Integer | No | Image position on the page. |
| images.list[].alt_issues | ENUM | No | Alt-text issues detected for the image. Allowed values: missing, empty_alt, filename, generic, duplicate, too_long, redundant_prefix, title_only. |
| images.list[].confidence | ENUM | No | Confidence or handling status for the finding. Allowed values: high, medium, review, manual, keep, ok, ok_if_decorative. |
| images.list[].current_alt | String | No | Current alt text, or null. |
| images.list[].lazy_loaded | Boolean | No | Whether the image is lazy-loaded. |
| images.list[].suggestions | Object | No | Alt suggestions per language, or null. Keys: ar, en, fr. |
| images.list[].suggestions.ar | String | No | Suggested Arabic alt text, or null. |
| images.list[].suggestions.en | String | No | Suggested English alt text, or null. |
| images.list[].suggestions.fr | String | No | Suggested French alt text, or null. |
| images.list[].file_size_kb | Integer | No | Image file size in KB, or null. |
| images.list[].size_checked | Boolean | No | Whether file size was checked. |
| images.list[].speed_issues | ENUM | No | Image speed-related issues. Allowed values: over_200kb, missing_dimensions, not_lazy_loaded, legacy_format. |
| images.list[].suggested_alt | String | No | Suggested alt text. |
| images.list[].has_dimensions | Boolean | No | Whether the image has dimensions. |
| images.total_found | Integer | No | Total number of images found. |
| images.size_checked | Integer | No | Number of images for which size was checked. |
| images.content_images | Integer | No | Number of content images. |
| images.alt_issue_counts | Object | No | Aggregate counts of alt issues. |
| images.with_alt_problems | Integer | No | Number of images with alt problems. |
| images.speed_issue_counts | Object | No | Aggregate counts of speed issues. |
| images.size_checks_skipped | Object | No | Counts or breakdown related to skipped size checks. |
| language | ENUM | No | Language used for the audit output. Allowed values: en, fr, ar. |
| final_url | String | No | Final URL after any redirects. |
| audited_at | String | No | Timestamp of when the audit was run. |
| robots_txt | Object | No | Robots.txt-related data. |
| score_breakdown | Object Array | No | Breakdown of scoring by issue. Each item includes issue and points. |
| score_breakdown[].issue | String | No | Issue name used in the score breakdown. |
| score_breakdown[].points | Integer | No | Points assigned to the issue. |


