Accessibility Issues ^Pro

An Accessibility issue corresponds to an issue found on a given web page when being checked by the A11Y checker.

Attributes

ID: Unique ID for this issue.
Help: Brief description of the issue.
Help URL: URL where you can find more info about the issue and proposed fixes.
URL: URL of the document the issue refers to. Typically this is the URL of the related Web Page.
HTML: Code snippets showing the affected elements.
Impact: Severity of the issue.
Impact Order: Numerical representation of the Impact.
Tags: Comma-separated list of tags to categorize this issue.
Inserted At: Timestamp when the Accessibility Issue was created.
Updated At: Timestamp when the Accessibility Issue was last updated.

Relationships

Report: The Report that this Accessibility Issue belongs to.
Web Page: The Web Page that this Accessibility Issue belongs to.

Example

Example: Accessibility Issue

{
    "data": {
        "attributes": {
            "help": "ARIA attributes must conform to valid names",
            "help_url": "https://dequeuniversity.com/rules/axe/4.8/aria-valid-attr",
            "html": [
                "<svg class=\"d-block mx-1\" title=\"Windows\" aria-title=\"Windows\" width=\"18\" height=\"18\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\" fill-rule=\"evenodd\" clip-rule=\"evenodd\" fill=\"currentColor\">",
                "<svg class=\"d-block mx-1\" title=\"Linux\" aria-title=\"Linux\" width=\"18\" height=\"18\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\" fill-rule=\"evenodd\" clip-rule=\"evenodd\" fill=\"currentColor\">",
                "<svg class=\"d-block mx-1\" title=\"Web\" aria-title=\"Web\" width=\"18\" height=\"18\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\" fill-rule=\"evenodd\" clip-rule=\"evenodd\" fill=\"currentColor\">",
                "<svg class=\"d-block mx-1\" title=\"macOS\" aria-title=\"macOS\" width=\"18\" height=\"18\" viewBox=\"0 0 24 24\" xmlns=\"http://www.w3.org/2000/svg\" fill-rule=\"evenodd\" clip-rule=\"evenodd\" fill=\"currentColor\">"
            ],
            "impact": "critical",
            "impact_order": 4,
            "inserted_at": "2024-03-05T12:45:14",
            "tags": [
                "cat.aria",
                "wcag2a",
                "wcag412",
                "EN-301-549",
                "EN-9.4.1.2"
            ],
            "updated_at": "2024-03-05T12:45:14",
            "url": "https://github.blog/2024-02-29-game-bytes-february-2024/"
        },
        "id": "26218481",
        "relationships": {
            "report": {
                "links": {
                    "related": "https://rocketvalidator.com/api/v1/reports/72eecced-8472-41fc-b194-59b7496c7576"
                }
            },
            "web_page": {
                "links": {
                    "related": "https://rocketvalidator.com/api/v1/reports/72eecced-8472-41fc-b194-59b7496c7576/web_pages/8413311"
                }
            }
        },
        "type": "a11y_issue"
    },
    "jsonapi": {
        "version": "1.0"
    }
}

List Accessibility issues on a web page

To list the accessibility issues found on a web page, send a GET request to /api/v1/reports/$REPORT_ID/web_pages/$WEBPAGE_ID/a11y_issues.

Example: list A11Y issues for a web page

GET /api/v1/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/a11y_issues

Filtering by help

To include only the accessibility issues of a given kind, use the filter[help] option.

Example: filter A11Y issues for a web page about "landmark"

GET /api/v1/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/a11y_issues?filter[help]=landmark

Filtering by tag

To include only the issues for a given tags combination, use the filter[tags] options:

filter[tags][mode] setting the tag combination mode, which can be any, all or none.
filter[tags][list] including a comma-separated list of tags.

Example: filter A11Y issues for a web page tagged with "wcag2a"

GET /api/v1/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/a11y_issues?filter[tags][mode]=any&filter[tags][list]=wcag2a

Retrieve an Accessibility issue

To show an individual Accessibility issue on a web page, send a GET request to /api/v1/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/a11y_issues/$A11Y_ISSUE_ID

Example: retrieve A11Y issue for a web page

GET `/api/v1/reports/$REPORT_ID/web_pages/$WEBPAGE_ID/a11y_issues/$A11Y_ISSUE_ID

Accessibility Issues Pro