Axe Issues

An Axe issue corresponds to an accessibility issue found on a given web page when being checked by Axe Core. It groups the elements on that page that fail the same Axe Core rule.

Attributes

ID

ID of the Axe Core rule that reports this issue, such as color-contrast.

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

List of tags to categorize this issue.

Inserted At

Timestamp when the Axe Issue was created.

Updated At

Timestamp when the Axe Issue was last updated.

Description

Short plain-text explanation of the issue, from the Rocket Validator guide that matches it. Null when no guide matches. This is Rocket Validator's own explanation, and is separate from the Help attribute, which carries the text supplied by the accessibility engine.

Description Markdown

The same explanation in Markdown. Null when no guide matches.

Description HTML

The same explanation as rendered HTML. Null when no guide matches.

Guide URL

Link to the full guide for this issue. Null when no guide matches.

Guide descriptions are not available for every issue

Rocket Validator publishes a guide for the most common issues, but not for every possible validator message. When no guide matches an issue, the four description and guide attributes are null. Treat them as optional.

Relationships

Report

The Report that this Axe Issue belongs to.

Web Page

The Web Page that this Axe Issue belongs to.

Example

Example: Axe Issue

{
  "data": {
    "attributes": {
      "description": "The names of ARIA attributes beginning with \"aria-\" must be correct.",
      "description_markdown": "The names of ARIA attributes beginning with \"aria-\" must be correct.",
      "description_html": "<p>The names of ARIA attributes beginning with &quot;aria-&quot; must be correct.</p>",
      "guide_url": "https://rocketvalidator.com/accessibility-validation/axe/4.8/aria-valid-attr",
      "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": "aria-valid-attr",
    "relationships": {
      "report": {
        "links": {
          "related": "https://rocketvalidator.com/api/v2/reports/72eecced-8472-41fc-b194-59b7496c7576"
        }
      },
      "web_page": {
        "links": {
          "related": "https://rocketvalidator.com/api/v2/reports/72eecced-8472-41fc-b194-59b7496c7576/web_pages/8413311"
        }
      }
    },
    "type": "axe_issue"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

List Axe issues on a web page

To list the Axe issues found on a web page, send a GET request to /api/v2/reports/$REPORT_ID/web_pages/$WEBPAGE_ID/axe_issues.

Example: list Axe issues for a web page

GET /api/v2/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/axe_issues

Filtering by help

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

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

GET /api/v2/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/axe_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 Axe issues for a web page tagged with "wcag2a"

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

Retrieve an Axe issue

To show an individual Axe issue on a web page, send a GET request to /api/v2/reports/$REPORT_ID/web_pages/$WEB_PAGE_ID/axe_issues/$RULE_ID

Example: retrieve the color contrast Axe issue for a web page

GET /api/v2/reports/$REPORT_ID/web_pages/$WEBPAGE_ID/axe_issues/color-contrast