API V2 reference (beta)

Common W3C Validator Issues

Typically, the same kind of issue affects many Web Pages on a given Report. For example, the issue "The “center” element is obsolete. Use CSS instead." may affect many Web Pages on the same report.

A Common W3C Validator Issue represents a given W3C Validator 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: Unique ID for this Common W3C Validator issue.
Report ID: Id of the related report.
Issue Type: Error or Warning
Issue Sub Type: Optional, provides additional info on the type of the issue.
Message: Brief description of the issue.
Tags: List of tags to categorize this issue.
How Many: Total times this issue has been found in the web pages for the report.
Description: Short plain-text explanation of the issue, from the Rocket Validator guide that matches it. Null when no guide matches.
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 W3C Validator Issue

{
  "data": {
    "attributes": {
      "description": "Each HTML element must have unique attribute names \u2014 no attribute can appear more than once on the same element.",
      "description_markdown": "Each HTML element must have unique attribute names \u2014 no attribute can appear more than once on the same element.",
      "description_html": "<p>Each HTML element must have unique attribute names \u2014 no attribute can appear more than once on the same element.</p>",
      "guide_url": "https://rocketvalidator.com/html-validation/duplicate-attribute-x",
      "how_many": 132,
      "issue_sub_type": null,
      "issue_type": "error",
      "message": "Duplicate attribute \u201cid\u201d.",
      "report_id": "72eecced-8472-41fc-b194-59b7496c7576",
      "tags": [
        "duplicate attribute"
      ]
    },
    "id": "144375908",
    "relationships": {
      "web_pages": {
        "links": {
          "related": "https://rocketvalidator.com/api/v2/reports/72eecced-8472-41fc-b194-59b7496c7576/web_pages?filter[common_w3c_validator_issue_id]=144375908"
        }
      }
    },
    "type": "common_w3c_validator_issue"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

List Common W3C Validator Issues on a Report

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

Example: list the Common W3C Validator issues found on a report
GET /api/v2/reports/$REPORT_ID/common_w3c_validator_issues

Filtering by message

To include only the W3C Validator issues of a given kind, use the filter[message] option.

Example: filter W3C Validator issues for a report about "table"
GET /api/v2/reports/$REPORT_ID/common_w3c_validator_issues?filter[message]=table

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 W3C Validator issues for a report tagged with "label"
GET /api/v2/reports/$REPORT_ID/common_w3c_validator_issues?filter[tags][mode]=any&filter[tags][list]=label

Retrieve a Common W3C Validator Issue

To retrieve a Common W3C Validator Issue on a given Report, send a GET request to /api/v2/reports/$REPORT_ID/common_w3c_validator_issues/$COMMON_W3C_VALIDATOR_ISSUE_ID.

Example: retrieve a Common W3C Validator issue on a report
GET /api/v2/reports/$REPORT_ID/common_w3c_validator_issues/$COMMON_W3C_VALIDATOR_ISSUE_ID

List the Web Pages affected by a Common W3C Validator Issue

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