API V2 reference (beta)
Resources
For a better understanding of the Rocket Validator API, a brief description of the resources you can manage is in order.
Report
A Report represents a validation report you've created in Rocket Validator. Contains a list of web pages that were found from the starting url, and the issues that W3C Validator, Axe Core and AccessLint Core found on them.
Web Page
A Web Page represents an HTML web page that has been found by the scraper, and is associated to a Report.
W3C Validator Issue
A W3C Validator Issue corresponds to an issue found on a given web page when being checked by the W3C Validator.
Axe Issue
An Axe Issue corresponds to an issue found on a given web page when being checked by Axe Core.
Axe Manual Review
An Axe Manual Review corresponds to a check that Axe Core couldn't settle on its own on a given web page, so a person needs to review it.
AccessLint Issue
An AccessLint Issue corresponds to an issue found on a given web page when being checked by AccessLint Core.
Common W3C Validator Issue
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.
Common Axe Issue
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.
Common Axe Manual Review
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.
Common AccessLint Issue
A Common AccessLint Issue represents a given AccessLint 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.
Raw Check
A Raw Check contains the raw output of the check, unprocessed, as returned by the W3C Validator, Axe Core or AccessLint Core.
Schedule
A Schedule represents a programmed report that will be run on a given periodicity, or after a deploy webhook is received.
Think of a Scheduled Report as a regular Report, that can be set to run automatically on a defined schedule or via deploy hooks.
Device
A Device represents the viewport settings for Device Viewport Emulation, including viewport width and height, scale factor, rotation, and others.
Muting
A Muting represents a rule you've defined to automatically mute certain issues on your reports, when those issues match the message and URL pattern.
Guest Account
A Guest Accounts is an invitation to other person in your team to use Rocket Validator without needing to set up a subscription of their own.