The following is an inventory of all LMS event types.
This inventory is comprised of a table of Common Fields that appear in all events, a table of Student Event Types which lists all interaction with the LMS outside of the Instructor Dashboard, and a table of Instructor Event Types of all interaction with the Instructor Dashboard in the LMS.
This section contains a table of fields common to all events.
| Common Field | Details | Type | Values/Format |
|---|---|---|---|
| agent | Browser agent string of the user who triggered the event. | string | |
| event | Specifics of the triggered event. | string/JSON | |
| event_source | Specifies whether the triggered event originated in the browser or on the server. | string | ‘browser’, ‘server’, ‘task’ |
| event_type | The type of event triggered. Values depend on event_source | string | (see below) |
| ip | IP address of the user who triggered the event. | string | |
| page | Page user was visiting when the event was fired. | string | ‘$URL’ |
| session | This key identifies the user’s session. May be undefined. | string | 32 digits |
| time | Gives the GMT time at which the event was fired. | string | ‘YYYY-MM-DDThh:mm:ss.xxxxxx’ |
| username | The username of the user who caused the event to fire. This string is empty for anonymous events (i.e., user not logged in). | string |
There are two tables of event types – one for student events, and one for instructor events. Table columns describe what each event type represents, which component it originates from, what scripting language was used to fire the event, and what event fields are associated with it. The event_source field from the “Common Fields” table above distinguishes between events that originated in the browser (in javascript) and events that originated on the server (during the processing of a request).
Event types with several different historical names are enumerated by forward slashes. Rows identical after the second column have been combined, with the corresponding event types enumerated by commas.
The Student Event Type table lists the event types logged for interaction with the LMS outside the Instructor Dashboard.
| Event Type | Description | Component | Language | event Fields | Type | Details |
|---|---|---|---|---|---|---|
| seq_goto | Fired when a user jumps between units in a sequence. | Sequence | CoffeeScript/JS | old | integer | Index of the unit being jumped from. |
| new | integer | Index of the unit being jumped to. | ||||
| id | integer | edX ID of the sequence. | ||||
| seq_next | Fired when a user navigates to the next unit in a sequence. | Sequence | CoffeeScript/JS | old | integer | Index of the unit being navigated away from. |
| new | integer | Index of the unit being navigated to. | ||||
| id | integer | edX ID of the sequence. | ||||
| seq_prev | Fired when a user navigates to the previous unit in a sequence. | Sequence | CoffeeScript/JS | old | integer | Index of the unit being navigated away from. |
| new | integer | Index of the unit being navigated to. | ||||
| id | integer | edX ID of the sequence. | ||||
| problem_check | Fired when a user wants to check a problem. | Capa | CoffeeScript/JS | The event field contains the values of all input fields from the problem being checked, styled as GET parameters. | ||
| problem_reset | Fired when a problem is reset. | Capa | CoffeeScript/JS | |||
| problem_show | Fired when a problem is shown. | Capa | CoffeeScript/JS | problem | string | ID of the problem being shown (e.g., i4x://MITx/6.00x/problem/L15:L15_Problem_2). |
| problem_save | Fired when a problem is saved. | Capa | CoffeeScript/JS | |||
| oe_hide_question / oe_hide_problem peer_grading_hide_question / peer_grading_hide_problem staff_grading_hide_question / staff_grading_hide_problem | Combined Open-Ended Peer Grading Staff Grading |
CoffeeScript/JS | location | string | The location of the question whose prompt is being hidden. | |
| oe_show_question / oe_show_problem peer_grading_show_question / peer_grading_show_problem staff_grading_show_question / staff_grading_show_problem | Combined Open-Ended Peer Grading Staff Grading |
CoffeeScript/JS | location | string | The location of the question whose prompt is being shown. | |
| rubric_select | Combined Open-Ended | CoffeeScript/JS | location | string | The location of the question whose rubric is being selected. | |
| selection | integer | Value selected on rubric. | ||||
| category | integer | Rubric category selected. | ||||
| oe_show_full_feedback oe_show_respond_to_feedback | Combined Open-Ended | CoffeeScript/JS | ||||
| oe_feedback_response_selected | Combined Open-Ended | CoffeeScript/JS | value | integer | Value selected in the feedback response form. | |
| page_close | This event type originates from within the Logger itself. | Logger | CoffeeScript/JS | |||
| play_video | Fired on video play. | Video | CoffeeScript/JS | id | string | EdX ID of the video being watched (e.g., i4x-HarvardX-PH207x-video-Simple_Random_Sample). |
| code | string | YouTube ID of the video being watched (e.g., FU3fCJNs94Y). | ||||
| pause_video | Fired on video pause. | |||||
| currentTime | float | Time the video was played at, in seconds. | ||||
| speed | string | Video speed in use (i.e., 0.75, 1.0, 1.25, 1.50). | ||||
| book | Fired when a user is reading a PDF book. | PDF Viewer | JS | type | string | ‘gotopage’, ‘prevpage’, ‘nextpage’ |
| old | integer | Original page number. | ||||
| new | integer | Destination page number. | ||||
| showanswer / show_answer | Server-side event which displays the answer to a problem. | Capa Module | Python | problem_id | string | EdX ID of the problem being shown. |
| problem_check_fail | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being checked. | ||||
| answers | dict | |||||
| failure | string | ‘closed’, ‘unreset’ | ||||
| problem_check / save_problem_check | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being checked. | ||||
| answers | dict | |||||
| success | string | ‘correct’, ‘incorrect’ | ||||
| attempts | integer | |||||
| correct_map | string / JSON | See the table in Addendum: correct_map Fields and Values below | ||||
| problem_rescore_fail | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being rescored. | ||||
| failure | string | ‘unsupported’, ‘unanswered’, ‘input_error’, ‘unexpected’ | ||||
| problem_rescore | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being rescored. | ||||
| orig_score | integer | |||||
| orig_total | integer | |||||
| new_score | integer | |||||
| new_total | integer | |||||
| correct_map | string / JSON | (See above.) | ||||
| success | string | ‘correct’, ‘incorrect’ | ||||
| attempts | integer | |||||
| save_problem_fail | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being saved. | ||||
| failure | string | ‘closed’, ‘done’ | ||||
| answers | dict | |||||
| save_problem_success | Capa Module | Python | state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being saved. | ||||
| answers | dict | |||||
| reset_problem_fail | Capa Module | Python | old_state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being reset. | ||||
| failure | string | ‘closed’, ‘not_done’ | ||||
| reset_problem | Capa Module | Python | old_state | string / JSON | Current problem state. | |
| problem_id | string | ID of the problem being reset. | ||||
| new_state | string / JSON | New problem state. |
Table of correct_map field types and values for the problem_check student event type above.
| correct_map field | Type | Values / Format | Null Allowed? |
|---|---|---|---|
| answer_id | string | ||
| correctness | string | ‘correct’, ‘incorrect’ | |
| npoints | integer | Points awarded for this answer_id. | yes |
| msg | string | Gives extra message response. | |
| hint | string | Gives optional hint. | yes |
| hintmode | string | None, ‘on_request’, ‘always’ | yes |
| queuestate | dict | None when not queued, else {key:’ ‘, time:’ ‘} where key is a secret string and time is a string dump of a DateTime object of the form ‘%Y%m%d%H%M%S’. | yes |
The Instructor Event Type table lists the event types logged for course team interaction with the Instructor Dashboard in the LMS.
| Event Type | Description | Component | Language | event Fields | Type | Details |
| list-students, dump-grades, dump-grades-raw, dump-grades-csv, dump-grades-csv-raw, dump-answer-dist-csv, dump-graded-assignments-config | Instructor Dashboard | Python | ||||
| rescore-all-submissions, reset-all-attempts | Instructor Dashboard | Python | problem | string | ||
| course | string | |||||
| delete-student-module-state, rescore-student-submission | Instructor Dashboard | Python | problem | string | ||
| student | string | |||||
| course | string | |||||
| reset-student-attempts | Instructor Dashboard | Python | old_attempts | string | ||
| student | string | |||||
| problem | string | |||||
| instructor | string | |||||
| course | string | |||||
| get-student-progress-page | Instructor Dashboard | Python | student | string | ||
| instructor | string | |||||
| course | string | |||||
| list-staff, list-instructors, list-beta-testers | Instructor Dashboard | Python | ||||
| add-instructor, remove-instructor | Instructor Dashboard | Python | instructor | string | ||
| list-forum-admins, list-forum-mods, list-forum-community-TAs | Instructor Dashboard | Python | course | string | ||
| remove-forum-admin, add-forum-admin, remove-forum-mod, add-forum-mod, remove-forum-community-TA, add-forum-community-TA | Instructor Dashboard | Python | username | string | ||
| course | string | |||||
| psychometrics-histogram-generation | Instructor Dashboard | Python | problem | string | ||
| add-or-remove-user-group | Instructor Dashboard | Python | event_name | string | ||
| user | string | |||||
| event | string |