API V2 reference (beta)
Raw Checks
A Raw Check contains the raw output of a web page check, unprocessed, as returned by the W3C Validator, Axe Core or AccessLint Core.
Rocket Validator processes the raw checks to extract the issues and present them in a more user-friendly way in the web interface. However, you can also access the raw checks if you need to process them in your own way.
Requesting store of raw checks
If not told otherwise, the raw checks are not stored and are deleted after they've been processed to generate the W3C Validator, Axe and AccessLint issues.
If you need to keep the raw checks for later processing, you can request these options when you create the report:
store_raw_w3c_validator_checks: true
store_raw_axe_checks: true
store_raw_accesslint_checks: true
Credit cost for raw checks
Storing raw checks costs no extra credits. You're charged for the engine run that produced each raw result, whether or not you keep it.
For example, a report with W3C Validator and Axe Core checks on 10 web pages consumes 20 credits (10 W3C Validator checks and 10 Axe Core checks), with or without raw storage enabled. See Credits for the full breakdown.
Please consider not storing raw checks unless you need them, or only storing the kind of raw checks you need (W3C Validator, Axe Core and / or AccessLint Core).
Attributes
- ID
- Unique ID for this raw check.
- Kind
- Type of the raw check:
w3c_validator, axe or accesslint. - Raw
- Raw data of the check, as returned by the W3C Validator, Axe Core or AccessLint Core.
Example
Example: W3C Validator Raw Check
{
"data": {
"attributes": {
"kind": "w3c_validator",
"raw": {
"language": "en",
"messages": [
{
"extract": "t=\"UTF-8\"><script type=\"text/javascript\">(windo",
"firstColumn": 24,
"hiliteLength": 31,
"hiliteStart": 10,
"lastColumn": 54,
"lastLine": 4,
"message": "The \u201ctype\u201d attribute is unnecessary for JavaScript resources.",
"subType": "warning",
"type": "info"
},
{
"extract": "on.ico\">\n\t<meta name='robots' content='index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1' />\n\n\t<!-",
"firstColumn": 2,
"hiliteLength": 109,
"hiliteStart": 10,
"lastColumn": 110,
"lastLine": 9,
"message": "Trailing slash on void elements has no effect and interacts badly with unquoted attribute values.",
"type": "info"
}
],
"url": "https://github.blog/ai-and-ml/generative-ai/how-ai-code-generation-works/"
}
},
"id": "14691003",
"type": "raw_check"
},
"jsonapi": {
"version": "1.0"
}
}
Get the W3C Validator Raw Check for a Web Page
To get the W3C Validator raw check for a web page, use the following endpoint:
Example: get the W3C Validator raw check for a web page
GET /api/v2/reports/{{REPORT_ID}}/web_pages/{{WEB_PAGE_ID}}/raw_w3c_validator_check
Get the Axe Raw Check for a Web Page
To get the Axe Core raw check for a web page, use the following endpoint:
Example: get the Axe raw check for a web page
GET /api/v2/reports/{{REPORT_ID}}/web_pages/{{WEB_PAGE_ID}}/raw_axe_check
Get the AccessLint Raw Check for a Web Page
To get the AccessLint Core raw check for a web page, use the following endpoint:
Example: get the AccessLint raw check for a web page
GET /api/v2/reports/{{REPORT_ID}}/web_pages/{{WEB_PAGE_ID}}/raw_accesslint_check
JSON output of W3C HTML Validator
For more information about the JSON output of the W3C HTML Validator, see the W3C HTML Validator documentation.
JSON output of Axe Core
The results object of Axe Core contains not only the violations found, but also the incomplete (also known as "review items") and passing checks. You can learn more about the Axe Core results object in the Axe Core documentation.
JSON output of AccessLint Core
For more information about AccessLint Core and the results it returns, see the AccessLint Core documentation.