API V2 reference (beta)

Common Axe Issues

Typically, the same kind of issue affects many Web Pages on a given Report. For example, the issue "Form elements must have labels" may affect many Web Pages on the same report.

A Common Axe Issue represents a given Axe Issue that is common to many Web Pages, thus showing its details, how many times it's found on the Report, and links to the related Web Pages.

Attributes

ID: ID of the Axe Core rule that reports this issue, such as color-contrast.
Report ID: ID of the report.
Help: Brief description of the issue.
Help URL: URL where you can find more info about the issue and proposed fixes.
How Many: Total times this issue has been found in the web pages for the report.
Impact: Severity of the issue.
Impact Order: Numerical representation of the Impact.
Tags: List of tags to categorize this issue.
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

Web Pages: The list of Web Pages affected by this issue.

Example

Example: Common 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?application=axe-puppeteer",
      "how_many": 1,
      "impact": "critical",
      "impact_order": 4,
      "report_id": "72eecced-8472-41fc-b194-59b7496c7576",
      "tags": [
        "cat.aria",
        "wcag2a",
        "wcag412",
        "EN-301-549",
        "EN-9.4.1.2"
      ]
    },
    "id": "aria-valid-attr",
    "relationships": {
      "web_pages": {
        "links": {
          "related": "https://rocketvalidator.com/api/v2/reports/72eecced-8472-41fc-b194-59b7496c7576/web_pages?filter[common_axe_issue_id]=aria-valid-attr"
        }
      }
    },
    "type": "common_axe_issue"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

List Common Axe Issues on a Report

To list the Common Axe issues found on a report, send a GET request to /api/v2/reports/$REPORT_ID/common_axe_issues.

Example: list the Common Axe issues found on a report
GET /api/v2/reports/$REPORT_ID/common_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 report about "landmark"
GET /api/v2/reports/$REPORT_ID/common_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 report tagged with "wcag2a"
GET /api/v2/reports/$REPORT_ID/common_axe_issues?filter[tags][mode]=any&filter[tags][list]=wcag2a

Retrieve a Common Axe Issue

To retrieve a Common Axe Issue on a given Report, send a GET request to /api/v2/reports/$REPORT_ID/common_axe_issues/$RULE_ID.

Example: retrieve the color contrast Common Axe issue on a report
GET /api/v2/reports/$REPORT_ID/common_axe_issues/color-contrast

List the Web Pages affected by a Common Axe Issue

To list the Web Pages that are affected by a given issue, refer to Filtering by Axe issue on the Web pages endpoint.