Accessibility Course Statistics

circle-exclamation

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"
}

AccessibilityCourseStatisticsController#indexarrow-up-right

GET /api/v1/users/:user_id/educator_accessibility_course_statistics

Scope: url:GET|/api/v1/users/:user_id/educator_accessibility_course_statistics

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).

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.

Returns a list of AccessibilityCourseStatistic objects.


This documentation is generated directly from the Canvas LMS source code, available on Githubarrow-up-right.

Last updated

Was this helpful?