Learner Usage/Progress

About

The Learner Usage/Progress data export allows instructors to understand how their learners are using Brightspace Learning Environment.

Available Filters

Filter

Description

Attributes

RolesIdsToInclude

A comma-separated list of role IDs. If an asterisk (*) is included, all roles are reported on. Default is to show all roles.

 

ShowInactiveUsers

This filter determines if progress for users whose accounts are inactive should be exported. Use true to return all users. Use false to return only active users.

true or false. Default is false.

ShowInactiveCourses

This filter determines if progress is exported for inactive course offerings. Use true to return both active and inactive courses. Use false to return only active courses.

true or false. Default is false.

StartDate

Filters data by last visited dates later than the start date. Null last visited dates are not filtered.

yyyy-mm-dd

EndDate

Filters data by last visited dates earlier than the end date. Null last visited dates are not filtered.

yyyy-mm-dd

DaysBack

This determines the start date of the data export. If an end date was also provided, this parameter determines how many days before the end date to set the start date of the export.

Integer

Returned Fields

Field Name

Description

Can be Null?

Multiple Values Supported?

If Multiple Values Supported - Delimiter

CourseOfferingID

Unique course offering numeric identifier within Brightspace Learning Environment.

N

N

 

CourseOfferingCode

Course offering string code.

Y

N

 

CourseOfferingName

Course offering string name.

N

N

 

CourseSectionId

Unique identifier for the course section within Brightspace Learning Environment.

Y

N

{null}

CourseSectionCode

The client-defined code for the course section.

Y

N

{null}

CourseSectionName

The name of the course section.

Y

N

{null}

ParentDepartmentName

The organization unit name of the parent department.

N

N

 

ParentDepartmentCode

The organization unit code of the parent department.

Y

N

 

SemesterId

Unique semester numeric identifier within Brightspace Learning Environment.

If a course is not associated with a semester, the resulting value is null.

Y

Y

|

SemesterCode

Semester code associated with this course offering.

The semester is the organization unit type as defined by the standard semester in Brightspace Learning Environment.

If a semester is not associated as a direct parent of the course offering being exported, the resulting value is null.

If a course offering is associated with multiple semesters, they are exported as a pipe-delimited list of strings.

Y

Y

|

SemesterName

Semester name associated with this course offering.

Y

Y

|

UserId

Internal numeric user identifier within Brightspace Learning Environment.

N

N

 

Username

Username that identifies the user.

N

N

 

OrgDefinedId

Organization-defined identifier within Brightspace Learning Environment for this user.

N

N

 

Firstname

User's first name.

N

N

 

Lastname

User's last name.

N

N

 

RoleID

The user's numeric role ID within the course offering.

N

N

 

RoleName

A string identifying the user's role within the course offering such as learner, teacher, etc.

Y

N

 

ContentCompleted

Number of content topics completed by the user.

N

N

 

ContentRequired

Number of content topics required by the user (for user progress).

Required:Manual and Required:Automatic. These refer to published topics.

N

N

 

ChecklistCompleted

Number of checklists completed by the user.

N

N

 

QuizCompleted

Number of quizzes completed by the user.

N

N

 

TotalQuizAttempts

Number of times quizzes were attempted by the user.

N

N

 

DiscusstionPostCreated

Number of discussion posts created by the user.

N

N

 

DiscussionPostReplies

Number of discussion post replies submitted by the user.

N

N

 

DiscussionPostRead

Number of discussion posts read by the user.

N

N

 

LastDiscussionPostDate

The date the user last posted to a discussion.

If the user has not posted in any discussion forum, this field is null.

Y

N

 

NumberOfDropboxSubmissions

The number of times this user submitted an item to assignments within the course offering.

N

N

 

LastDropboxSubmissionDate

The date / time the learner last submitted / posted in an assignment.

Y

N

 

TotalTimeSpentInContent

This is the sum of all the time spent in course content.

If the learner has not visited any of the content in this course, this field contains zero.

TotalTimeSpent is an approximate based on normal usage.

If the learner has multiple instances/tabs open with the same content, this filter tracks each instance as a separate session, and as a result, increases total time spent substantially.

N

N

 

LastVisitedDate

This is the most recent visit date/time for this course

If the course has not been visited by the user, this field is null.

Y

N

 

LastSystemLogin

The date/time this user last logged in to Brightspace Learning Environment.

Y

N

 

NumberofLoginsToTheSystem

The total number of times this user has logged in to Brightspace Learning Environment.

N

N

 

AuditorName

The username of the person who is assigned as the auditor for this user.

Y

Y

|

Sample output file

Data export learner usage progress output file

Sample request file

<request>

<report>LearnerUsageProgressExport</report>

<filename>LearnerUsageProgressExport_%d_%t.csv</filename>

<courses>

<parent orgunitid="6606" />

</courses>

<parameter>

<name>ShowInactiveCourses</name>

<value>true</value>

</parameter>

<parameter>

<name>ShowInactiveUsers</name>

<value>false</value>

</parameter>

<parameter>

<name>RoleIdsToInclude</name>

<value>*</value>

</parameter>

</request>