Accessibility Issues
An Accessibility issue corresponds to an issue found on a given web page when being checked by the A11Y checker.
Attributes
- ID
- Unique ID for this issue.
- Help
- Brief description of the issue.
- Help URL
- URL where you can find more info about the issue and proposed fixes.
- URL
- URL of the document the issue refers to. Typically this is the URL of the related Web Page.
- HTML
- Code snippets showing the affected elements.
- Impact
- Severity of the issue.
- Impact Order
- Numerical representation of the Impact.
- Tags
- List of Accessibility guidelines that relate to this issue.
- Inserted At
- Timestamp when the Accessibility Issue was created.
- Updated At
- Timestamp when the Accessibility Issue was last updated.
Relationships
- Report
- The Report that this Accessibility Issue belongs to.
- Web Page
- The Web Page that this Accessibility Issue belongs to.
Example
Example: Accessibility Issue
{
"attributes": {
"help": "Form elements must have labels",
"help_url": "https://dequeuniversity.com/rules/axe/3.5/label?application=rocketvalidator",
"html": [
"<input type=\"email\" style=\"margin-top: 15px;\" value=\"\" name=\"EMAIL\" class=\"email\" id=\"mce-EMAIL_footer\" placeholder=\"Your email\" required=\"\">",
"<input id=\"mce-EMAIL_footer\" class=\"email\" style=\"margin-top: 10px; margin-bottom: 10px;\" name=\"EMAIL\" required=\"\" type=\"email\" value=\"\" placeholder=\"Your email\">"
],
"id": 7657099,
"impact": "critical",
"impact_order": 4,
"inserted_at": "2020-04-02T12:44:50",
"tags": [
"cat.forms",
"wcag2a",
"wcag412",
"wcag131",
"section508",
"section508.22.n"
],
"updated_at": "2020-04-02T12:44:50",
"url": "https://example.com/about"
},
"id": "7657099",
"relationships": {
"report": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/56b6"
}
},
"web_page": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/56b6/web_pages/2884097"
}
}
},
"type": "a11y_issue"
}
List Accessibility issues on a web page
To list the Accessibility issues found on a web page, send a GET
request to /api/v0/reports/$REPORT_ID/web_pages/$WEBPAGE_ID/a11y_issues
.
Example: GET https://rocketvalidator.com/api/v0/reports/9314c/web_pages/472/a11y_issues
{
"data": [
{
"attributes": {
"help": "Images must have alternate text",
"help_url": "https://dequeuniversity.com/rules/axe/3.5/image-alt?application=rocketvalidator",
"html": [
"<img src=\"/images/fire.png\" align=\"absmiddle\" width=\"30\" hspace=\"5\">",
"<img src=\"/images/nuke.gif\" width=\"100%\" vspace=\"8\">"
],
"id": 6843979,
"impact": "critical",
"impact_order": 4,
"inserted_at": "2020-02-28T13:01:35",
"tags": [
"cat.text-alternatives",
"wcag2a",
"wcag111",
"section508",
"section508.22.a"
],
"updated_at": "2020-02-28T13:01:35",
"url": "http://validationhell.com/"
},
"id": "6843979",
"relationships": {
"report": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/9314c"
}
},
"web_page": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/9314c/web_pages/472"
}
}
},
"type": "a11y_issue"
},
{
"attributes": {
"help": "<ul> and <ol> must only directly contain <li>, <script> or <template> elements",
"help_url": "https://dequeuniversity.com/rules/axe/3.5/list?application=rocketvalidator",
"html": [
"<ul class=\"nav nav-list\">"
],
"id": 6843982,
"impact": "serious",
"impact_order": 3,
"inserted_at": "2020-02-28T13:01:35",
"tags": [
"cat.structure",
"wcag2a",
"wcag131"
],
"updated_at": "2020-02-28T13:01:35",
"url": "http://validationhell.com/"
},
"id": "6843982",
"relationships": {
"report": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/9314c"
}
},
"web_page": {
"links": {
"related": "https://rocketvalidator.com/api/v0/reports/9314c/web_pages/472"
}
}
},
"type": "a11y_issue"
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "https://rocketvalidator.com/api/v0/reports/9314c/web_pages/472/a11y_issues?page[number]=1&page[size]=25"
}
}