The Accessibility API evaluates HTML emails against WCAG standards, providing a clear pass/fail assessment to ensure compliance with accessibility guidelines.
Retrieve a paginated list of all accessibility tests that have been submitted. Each test includes details such as its status, the number of checks performed, and, of those checks, how many passes and failures there were. The response is paginated, with a limit of up to 1000 items per page. The total count of records will display in the meta object under the key, 'count'.
A 200 response
object | |
object | |
Array of objects |
A 401 response
{- "meta": {
- "count": 9
}, - "items": [
- {
- "id": "675c62d60a1d3f3547e3c08c",
- "status": "Complete",
- "checks": 57,
- "passes": 39,
- "failures": 6
}
]
}
This endpoint allows users to submit an accessibility test for processing. It accepts a set of HTML content, processes it for accessibility issues, and returns a unique job ID for tracking the status of the test. The status of the job will display in the meta object, with a status of 'Processing'.
A 201 response
object | |
object |
A 400 response
A 401 response
{- "html": "string"
}
{- "meta": {
- "status": "Processing"
}, - "items": {
- "id": "677ea3cdf1051e25e7dbfe73",
- "links": {
}
}
}
Retrieve the details of a specific accessibility test using the provided test ID. This endpoint returns comprehensive details about the test, including metadata and test results.
A 200 response
object | |
Array of objects |
A 401 response
A 404 response
{- "meta": {
- "status": "Complete"
}, - "items": [
- {
- "checks": 57,
- "passes": [
- {
- "rule": "Accesskeys",
- "description": "Ensures every accesskey attribute value is unique",
- "standards": [
- "Best Practice"
]
}
], - "failures": [
- {
- "rule": "Check Title Attributes",
- "impact": "serious",
- "description": "Ensures links have discernible text",
- "standards": [
- "WCAG 2A"
], - "instances": [
- {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv_XcHKdsGWmibEMhJn2Ru0Vc4ot3FmxMJVzPN-4kC1AuC07RcQKADk0Qp_vkt-5spaVWYFvk2IkLL-eGhtmZ3v-H44j1FGVVebSQWu3DyovyMw-NBaHm8Df6sIqWaN4rOpr1uYN69MVJ2QiBEnBh2Kh4Mtc8LTa1Dq-lCP1hoK7DOcl1vGOiUyA2oo1ef43gKBoPOVrJ0loTHhQ2bvTy523hW8Z8J829NtKdgcIAdGQANUmH1OqXXVwZU3eQMfKDXJzHzOz_bCjH91SkuKYhmG_5UM8lsbHtvlEQSdv7Kkt1rsecakquNMtCQq5E9ioRx8Ku9gaYn5ZgI-v5-OvKB53rLv_LDnVowGIQopw4nxcd\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVea_4e-IiWzWLZQ6G3c0nhvDpLDeVSrJzlcZ1IzZgRU31vwRAWT6064qAF-H4uIIPNP5IX2uIW3u4E0A3q1apBN_cjwrWKBaq3LX_Yph0XZYLhTkE42C2_SLJAL_Q8ofTWXCvuL9RD60qSb_7fpYbrzkmtGKwv5WXoXWBKPBKE6BJx6K2oYelNkcUBA9axDa1viaUQE93Ufw2WdY1P85vKDGc57WyZKg_fdz3dJy_dhXeV0qqrygY2LHoNzOXtsVe73Kwwgj3T0N7oWFLAawzkn9WTFefnSyEHhg7zK76A4MgeitybIeTgQBlXWOGprWUtjeAMLBpp-z9geXzciRyuGEYFqVb2NNa4YyGMP_tErsmernTIYbWMEWSB9VRN6k7b\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVedwTM0j_e6NW3GDsBJNs0Sm2787dseb6OfhUK7VLbq8B2OQbn3gvPHXBBRKRaZAaZkNsBXRwCPYdvHSEzo_utuvFvO7FwFIGZ6M3rvZZe2HEd3d0Zl5QfCWL4nhBvg0FnGbWOeZhjDr2A-SWJJCUxvBKixrXGZoOf5nyr1AMnlRchMLmMWR-DPfvUjnfjSc8RvYzupE3ykTwQqTGtu0j6d_fR-Bvm-gETlGRhkI-MK8gV7Rxn5W2v4bgxAOz-ufh6lVdOYXWMWB9qiQ6rw24uUE2X1JRGiZUTGP6QV-mrluOz7740iUVGBJHR8xn8dWj-PXgYtTjG130i_77eRYO20RvbzrNFQNJXZLOG5fn64og3LsGPv81QcN06goMwgMcV0yRaf8ux4kxUpgSf5an3xg%3D%3D\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVen7WisoSvKscLPyuQlBALkIZn1aFnMMYsYqlpq7kZFGVOnEFc0VzrwU_dAYPgW3e5GSXv3iZKoO5JW8PWDYeMhMuuXF2Gk0K02KFqsmg18hYzGf9TgJ1xSneoUcOL4QrO0uMW4HSAbNVpGhAXZUAJZcK0SsXZdLEzK-jGmHaEBgE4Zc2ZvELcsFDT2W3U4Fx8tvz_pXBn73zs_f1jKjUmG_TxCfDw4MIawyludAHlUJ_OGUuBrTgo633-FW7OxM9hVObn3l5X9DYTGFYJrzi8afzNNcBslkuQrTvFEj5EgwRNV6EZdsoXACh2RL4hVlCmh8MNXTzuCJl4LmML1YdeV9lGXSrKeOeU3vthtkZ23n2_bKa2A5YumcndSQneRXPe\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}
]
}, - {
- "rule": "Check Title Attributes",
- "impact": "serious",
- "description": "Ensures links have discernible text",
- "standards": [
- "WCAG 2A"
], - "instances": [
- {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv_XcHKdsGWmibEMhJn2Ru0Vc4ot3FmxMJVzPN-4kC1AuC07RcQKADk0Qp_vkt-5spaVWYFvk2IkLL-eGhtmZ3v-H44j1FGVVebSQWu3DyovyMw-NBaHm8Df6sIqWaN4rOpr1uYN69MVJ2QiBEnBh2Kh4Mtc8LTa1Dq-lCP1hoK7DOcl1vGOiUyA2oo1ef43gKBoPOVrJ0loTHhQ2bvTy523hW8Z8J829NtKdgcIAdGQANUmH1OqXXVwZU3eQMfKDXJzHzOz_bCjH91SkuKYhmG_5UM8lsbHtvlEQSdv7Kkt1rsecakquNMtCQq5E9ioRx8Ku9gaYn5ZgI-v5-OvKB53rLv_LDnVowGIQopw4nxcd\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVea_4e-IiWzWLZQ6G3c0nhvDpLDeVSrJzlcZ1IzZgRU31vwRAWT6064qAF-H4uIIPNP5IX2uIW3u4E0A3q1apBN_cjwrWKBaq3LX_Yph0XZYLhTkE42C2_SLJAL_Q8ofTWXCvuL9RD60qSb_7fpYbrzkmtGKwv5WXoXWBKPBKE6BJx6K2oYelNkcUBA9axDa1viaUQE93Ufw2WdY1P85vKDGc57WyZKg_fdz3dJy_dhXeV0qqrygY2LHoNzOXtsVe73Kwwgj3T0N7oWFLAawzkn9WTFefnSyEHhg7zK76A4MgeitybIeTgQBlXWOGprWUtjeAMLBpp-z9geXzciRyuGEYFqVb2NNa4YyGMP_tErsmernTIYbWMEWSB9VRN6k7b\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVedwTM0j_e6NW3GDsBJNs0Sm2787dseb6OfhUK7VLbq8B2OQbn3gvPHXBBRKRaZAaZkNsBXRwCPYdvHSEzo_utuvFvO7FwFIGZ6M3rvZZe2HEd3d0Zl5QfCWL4nhBvg0FnGbWOeZhjDr2A-SWJJCUxvBKixrXGZoOf5nyr1AMnlRchMLmMWR-DPfvUjnfjSc8RvYzupE3ykTwQqTGtu0j6d_fR-Bvm-gETlGRhkI-MK8gV7Rxn5W2v4bgxAOz-ufh6lVdOYXWMWB9qiQ6rw24uUE2X1JRGiZUTGP6QV-mrluOz7740iUVGBJHR8xn8dWj-PXgYtTjG130i_77eRYO20RvbzrNFQNJXZLOG5fn64og3LsGPv81QcN06goMwgMcV0yRaf8ux4kxUpgSf5an3xg%3D%3D\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}, - {
- "correctAny": [
- "Element does not have text that is visible to screen readers",
- "aria-label attribute does not exist or is empty",
- "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
- "Element has no title attribute"
], - "correctAll": [
- ""
], - "snippet": "<a href=\"https://itr.links.codecademy.com/u/click?_t=13e4e7efd5b34d1d982e9fb34505f006&_m=d49e0a49293847cb90a38fc966d6c628&_e=8PR4PaAxdle-t4DWaNnHv3_8_ILBeCvdyVFeRs3iXHpUr2MZ6Y0LBDzW2jsxCcVen7WisoSvKscLPyuQlBALkIZn1aFnMMYsYqlpq7kZFGVOnEFc0VzrwU_dAYPgW3e5GSXv3iZKoO5JW8PWDYeMhMuuXF2Gk0K02KFqsmg18hYzGf9TgJ1xSneoUcOL4QrO0uMW4HSAbNVpGhAXZUAJZcK0SsXZdLEzK-jGmHaEBgE4Zc2ZvELcsFDT2W3U4Fx8tvz_pXBn73zs_f1jKjUmG_TxCfDw4MIawyludAHlUJ_OGUuBrTgo633-FW7OxM9hVObn3l5X9DYTGFYJrzi8afzNNcBslkuQrTvFEj5EgwRNV6EZdsoXACh2RL4hVlCmh8MNXTzuCJl4LmML1YdeV9lGXSrKeOeU3vthtkZ23n2_bKa2A5YumcndSQneRXPe\" target=\"_blank\" style=\"outline: none; display: block; text-decoration: underline !important;\">"
}
]
}
]
}
]
}
Delete a specific accessibility test by its unique test ID. This endpoint allows you to remove an accessibility test from the system. If the test ID does not exist, the appropriate error message is returned.
{- "message": "Accessibility test with test id <id> has been successfully deleted."
}