API V2 reference (beta)

Common Axe Manual Reviews

The same rule often needs a manual review on many Web Pages of a report. For example, Axe Core may not be able to work out the contrast of text placed over a background image, and a site often repeats that design on every page.

A Common Axe Manual Review represents a given Axe Manual Review 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.

Rocket Validator only stores manual reviews for reports created with store_incomplete_checks, which needs perform_axe_checks. For any other report, the list is empty.

Attributes

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

Guide descriptions are not available for every rule
Rocket Validator publishes a guide for the most common issues, but not for every possible validator message. When no guide matches a manual review, the four description and guide attributes are null. Treat them as optional.

Relationships

Web Pages: The list of Web Pages where this rule needs a manual review.

Example

Example: Common Axe Manual Review

{
  "data": {
    "attributes": {
      "description": "Text elements must have sufficient color contrast between the foreground text and the background behind it. WCAG 2.1 (AA) requires a contrast ratio of at least 4.5:1 for normal-sized text and 3:1 for large text. To fix violations, adjust your text color, background color, or both until the required contrast ratio is met.",
      "description_html": "<p>Text elements must have sufficient color contrast between the foreground text and the background behind it. WCAG 2.1 (AA) requires a contrast ratio of at least 4.5:1 for normal-sized text and 3:1 for large text. To fix violations, adjust your text color, background color, or both until the required contrast ratio is met.</p>",
      "description_markdown": "Text elements must have sufficient color contrast between the foreground text and the background behind it. WCAG 2.1 (AA) requires a contrast ratio of at least 4.5:1 for normal-sized text and 3:1 for large text. To fix violations, adjust your text color, background color, or both until the required contrast ratio is met.",
      "guide_url": "https://rocketvalidator.com/accessibility-validation/axe/4.11/color-contrast",
      "help": "Elements must meet minimum color contrast ratio thresholds",
      "help_url": "https://dequeuniversity.com/rules/axe/4.11/color-contrast?application=axe-puppeteer",
      "how_many": 12,
      "impact": "serious",
      "impact_order": 3,
      "report_id": "2455a63a-7e16-4cbf-8455-6c9a88195142",
      "tags": [
        "cat.color",
        "wcag2aa",
        "wcag143",
        "EN-301-549",
        "EN-9.1.4.3"
      ]
    },
    "id": "color-contrast",
    "relationships": {
      "web_pages": {
        "links": {
          "related": "https://rocketvalidator.com/api/v2/reports/2455a63a-7e16-4cbf-8455-6c9a88195142/web_pages?filter[common_axe_manual_review_id]=color-contrast"
        }
      }
    },
    "type": "common_axe_manual_review"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

List Common Axe Manual Reviews on a Report

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

Example: list the Common Axe manual reviews found on a report
GET /api/v2/reports/$REPORT_ID/common_axe_manual_reviews

Filtering by help

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

Example: filter Axe manual reviews for a report about "contrast"
GET /api/v2/reports/$REPORT_ID/common_axe_manual_reviews?filter[help]=contrast

Filtering by tag

To include only the manual reviews 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 manual reviews for a report tagged with "wcag2aa"
GET /api/v2/reports/$REPORT_ID/common_axe_manual_reviews?filter[tags][mode]=any&filter[tags][list]=wcag2aa

Retrieve a Common Axe Manual Review

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

Example: retrieve the color contrast Common Axe manual review on a report
GET /api/v2/reports/$REPORT_ID/common_axe_manual_reviews/color-contrast

List the Web Pages affected by a Common Axe Manual Review

To list the Web Pages where a given rule needs a manual review, refer to Filtering by Axe manual review on the Web pages endpoint.