.course. analytics

Source:
Functions for getting course analytics

Methods

(async) getStudentMessagingData(opts, configopt) → {Promise.<CanvasUserInCourseMessagingData>}

Source:
Author:
  • Gabe Abrams
Gets messaging data for a student in a course
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
studentId number the id of the student to get analytics on
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
message data https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_messaging
Type
Promise.<CanvasUserInCourseMessagingData>

(async) getStudentParticipationData(opts, configopt) → {Promise.<CanvasUserInCourseParticipationData>}

Source:
Author:
  • Gabe Abrams
Gets participation data for a student in a course
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
studentId number the id of the student to get analytics on
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
participation data https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_participation
Type
Promise.<CanvasUserInCourseParticipationData>

(async) getStudentSummary(opts, configopt) → {Promise.<CanvasCourseLevelStudentSummary>}

Source:
Author:
  • Gabe Abrams
Gets a student summary for a student in a course
Parameters:
Name Type Attributes Description
opts object object containing all arguments
Properties
Name Type Attributes Default Description
studentId number id of the user to get analytics for
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
student summary https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_student_summaries
Type
Promise.<CanvasCourseLevelStudentSummary>

(async) listAssignmentSummaries(optsopt, configopt) → {Promise.<CanvasCourseLevelAssignmentData>}

Source:
Author:
  • Gabe Abrams
Gets a list of assignments summaries for all assignments in a course
Parameters:
Name Type Attributes Description
opts object <optional>
 object containing all arguments
Properties
Name Type Attributes Default Description
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of assignment summaries https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_assignments
Type
Promise.<CanvasCourseLevelAssignmentData>

(async) listDailyActivitySummaries(optsopt, configopt) → {Promise.<CanvasCourseLevelParticipationData>}

Source:
Author:
  • Gabe Abrams
Gets a list of daily activity summaries for each day in a course
Parameters:
Name Type Attributes Description
opts object <optional>
 object containing all arguments
Properties
Name Type Attributes Default Description
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of daily activity summaries https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_participation
Type
Promise.<CanvasCourseLevelParticipationData>

(async) listStudentSummaries(optsopt, configopt) → {Promise.<CanvasCourseLevelStudentSummaries>}

Source:
Author:
  • Gabe Abrams
Gets a list of student summaries for all students in a course
Parameters:
Name Type Attributes Description
opts object <optional>
 object containing all arguments
Properties
Name Type Attributes Default Description
courseId number <optional>
 default course id Canvas course Id to query
config APIConfig <optional>
 custom configuration for this specific endpoint call (overwrites defaults that were included when api was initialized)
Returns:
list of student summaries https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.course_student_summaries
Type
Promise.<CanvasCourseLevelStudentSummaries>