🚀 Heads up: Our API Docs Have Moved!
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
We have relocated to Instructure Developer Documentation Portal. 🎉 Please update your bookmarks. This page will automatically redirect after July 1, 2026.
Accessibility Course Statistics API
An AccessibilityCourseStatistic object looks like:
// Per-course accessibility issue counts for a user's active teacher/designer
// courses.
{
// The ID of the accessibility course statistic record
"id": 1,
// The ID of the course
"course_id": 42,
// The name of the course
"course_name": "Introduction to Biology",
// The course code (short name) of the course
"course_code": "BIO101",
// Whether the course is published
"published": true,
// The number of active accessibility issues in the course
"active_issue_count": 5,
// The number of resolved accessibility issues in the course
"resolved_issue_count": 3,
// The number of closed accessibility issues in the course
"closed_issue_count": 2,
// The workflow state of the statistic record
"workflow_state": "active",
// The date and time the record was created
"created_at": "2026-01-01T00:00:00Z",
// The date and time the record was last updated
"updated_at": "2026-01-02T00:00:00Z"
}
List accessibility course statistics AccessibilityCourseStatisticsController#index
GET /api/v1/users/:user_id/educator_accessibility_course_statistics
Scope:
Returns per-course accessibility issue statistics for the current user's
active teacher and designer courses. Only courses where the accessibility
checker is enabled and whose workflow state is neither completed nor deleted
are included. Only statistic records with workflow_state "active" are returned.
Requires the educator_dashboard feature flag to be enabled on the root
account, and a11y_checker_account_statistics on site admin plus a11y_checker
on the account (i.e. a11y_checker_account_statistics? must be true).
url:GET|/api/v1/users/:user_id/educator_accessibility_course_statistics
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| user_id | Required | string | The ID of the user, or "self" for the current user. The requesting user may only retrieve their own statistics. |
| enrollment_term_id | string | When present, only include courses that belong to the given enrollment term(s). Accepts a single term id or an array (enrollment_term_id[]=1&enrollment_term_id[]=2), and each value may be a term id or SIS term id. Returns 404 if any given term does not exist in this account. |
List accessibility course statistic terms AccessibilityCourseStatisticsController#terms
GET /api/v1/users/:user_id/educator_accessibility_course_terms
Scope:
Returns the distinct enrollment terms that the current user's active teacher
and designer courses belong to -- the same courses reported by the List
accessibility course statistics endpoint. Use this to populate a term filter
for that endpoint. There is no "all terms" entry; "all terms" is represented
by omitting the enrollment_term_id filter.
Requires the same account settings and feature flags as the statistics
endpoint.
url:GET|/api/v1/users/:user_id/educator_accessibility_course_terms
Request Parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| user_id | Required | string | The ID of the user, or "self" for the current user. The requesting user may only retrieve their own terms. |