.. _Student_Event_Types: ############## Student Events ############## This section lists events that are typically initiated by learners. These events are generated by interactions with the learning management system (LMS) other than the instructor dashboard. For a list of events generated by course team interactions on the instructor dashboard, see :ref:`Instructor_Event_Types`. For a complete, alphabetical list of events, see the :ref:`tracking_log_event_list`. .. contents:: :local: :depth: 1 The descriptions that follow include what each event represents, the system component it originates from, the history of any changes made to the event over time, and member fields in addition to the common ``context`` or ``event`` fields. The value in the ``event_source`` field distinguishes between events that originate in the browser (in JavaScript) and events that originate on the server (during the processing of a request). For more information about the common ``context`` or ``event`` fields, and about the ``event_source`` field, see :ref:`common`. .. Badging is currently available only on Open edX, so badging events section is commented out. Add to live doc when badging is supported on edx.org (CT) .. _badging_events: ***************** Badging Events ***************** This section includes descriptions of the following events related to badges, which are created when learners have achieved some course milestone, usually the awarding of a course certificate. Badges are created automatically when certificates are generated. A badge is uniquely identifiable by its assertion information. A badge assertion represents a badge being awarded to a learner, and describes the following three items. * Who the badge was awarded to. * What the badge represents (for example, course identifier, enrollment mode). * Who issued the badge (the issuing organization). When learners earn badges, they can download a badge image and share it on social networks or on badge display sites such as Mozilla Backpack. When other parties visit the shared badge links, they can view information that gives evidence of the learner's achievement. * ``edx.badge.assertion.created`` * ``edx.badge.assertion.shared`` * ``edx.badge.assertion.evidence_visited`` ================================= ``edx.badge.assertion.created`` ================================= When a badge is created that associates a specific learner with a specific achievement, the server emits an ``edx.badge.assertion.created`` event. **History**: Added 8 June 2015. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``assertion_id`` - number - The unique ID of the BadgeAssertion object. * - ``assertion_image_url`` - string - The URL of an image file of the badge that includes badge assertion information in the header. These files can serve to verify the user's accomplishment and can be easily shared. * - ``assertion_json_url`` - string - The URL of a JSON object containing the badge assertion information. * - ``course_id`` - string - The course associated with this badge. * - ``enrollment_mode`` - string - The course enrollment mode associated with this badge. * - ``issuer`` - string - The URL of the badge issuer's web site. * - ``user_id`` - number - The numeric ID of the learner who earned this badge. ================================= ``edx.badge.assertion.shared`` ================================= When a learner downloads a badge that she has earned for the purpose of sharing it on social media, the server emits an ``edx.badge.assertion.shared`` event. **History**: Added 8 June 2015. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.badge.assertion.shared`` event includes many of the same ``event`` member fields that are described for the ``edx.badge.assertion.created`` event. The following member fields serve the same purpose for ``edx.badge.assertion.shared`` as they do for ``edx.badge.assertion.created``. * ``assertion_id`` * ``assertion_image_url`` * ``assertion_json_url`` * ``course_id`` * ``enrollment_mode`` * ``issuer`` * ``user_id`` The following additional ``event`` member field applies specifically to ``edx.badge.assertion.shared`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``social_network`` - string - The social network to which the badge is shared. =========================================================== ``edx.badge.assertion.evidence_visited`` =========================================================== Each badge contains assertion information that includes an "evidence" field. When badges are displayed on sites such as Mozilla Backpack, the evidence field is used to provide a link to evidence that confirms the badge owner's achievement, usually a certificate. When other users visit social networks or a site such as Mozilla Backpack and use a badge's evidence link to view a badge owner's certificate, the server emits an ``edx.badge.assertion.evidence_visited`` event. **History**: Added 8 June 2015. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.badge.assertion.evidence_visited`` event includes all of the same ``event`` member fields that are described for the ``edx.badge.assertion.created`` event. The following member fields serve the same purpose for ``edx.badge.assertion.evidence_visited`` as they do for ``edx.badge.assertion.created``. * ``assertion_id`` * ``assertion_image_url`` * ``assertion_json_url`` * ``course_id`` * ``enrollment_mode`` * ``issuer`` * ``user_id`` .. _bookmark_events: ************************** Bookmark Events ************************** Bookmark events are described in :ref:`course_resources`. .. _certificate_events: ******************* Certificate Events ******************* This section includes descriptions of the events related to certificates, which are awarded to qualified learners when they complete a course. .. contents:: :local: :depth: 1 ================================= ``edx.certificate.created`` ================================= When a certificate is generated, a record is created in the ``certificates_generatedcertificate`` table, triggering an ``edx.certificate.created`` event. It may be important to note that it is possible for this event to be fired when an existing certificate record in the ``certificates_generatedcertificate`` table is updated. For example, if a certificate was revoked from a learner due to them no longer passing the course, and then they earned a passing grade at a later time, an ``edx.certificate.created`` event will be fired again (even though the record for this learner already exists in the database). **History** Added 2 September 2015. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``certificate_id`` - string - The ``verify_uuid`` value from the ``certificates_generatedcertificate`` table. This string appears at the bottom of each certificate. * - ``certificate_url`` - string - The URL for the certificate web page. * - ``course_id`` - string - The course for which this certificate is issued. * - ``enrollment_mode`` - string - The course enrollment mode associated with this certificate. * - ``generation_mode`` - string - Indicates whether this certificate was generated automatically for a learner in a course or whether a learner generated their own certificate. Possible values are "batch" and "self". * - ``user_id`` - number - The numeric ID of the learner who earned this certificate. ================================= ``edx.certificate.revoked`` ================================= There may be times where it is appropriate to remove a learner's access to their course certificate. Some (non-exhaustive) examples include: * The learner is no longer passing the course. * The course team has requested the learner be added to the certificate invalidation list. * The learner has been flagged as suspicious during a proctored exam. **History**: Added 27 May 2021. **Event Source**: Server ``event`` **Member Fields**: The ``edx.certificate.revoked`` event includes many of the same ``event`` member fields that are described for the ``edx.certificate.created`` event. The following member fields serve the same purpose for ``edx.certificate.revoked`` as they do for `edx.certificate.created`_. * ``certificate_id`` * ``certificate_url`` * ``course_id`` * ``enrollment_mode`` * ``user_id`` The following additional ``event`` member field applies specifically to ``edx.certificate.revoked`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``source`` - string - The source requesting revocation of the course certificate (e.g., the Instructor Dashboard's certificate invalidation tool). ================================= ``edx.certificate.shared`` ================================= When a learner shares the URL for their certificate on a social media web site, the server emits an ``edx.certificate.shared`` event. **History**: Added 2 September 2015. **Event Source**: Server ``event`` **Member Fields**: The ``edx.certificate.shared`` event includes many of the same ``event`` member fields that are described for the ``edx.certificate.created`` event. The following member fields serve the same purpose for ``edx.certificate.shared`` as they do for `edx.certificate.created`_. * ``certificate_id`` * ``certificate_url`` * ``course_id`` * ``enrollment_mode`` * ``user_id`` The following additional ``event`` member field applies specifically to ``edx.certificate.shared`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``social_network`` - string - The social network to which the certificate is shared, such as "LinkedIn", "Facebook", or "Twitter". ====================================== ``edx.certificate.evidence_visited`` ====================================== When a learner shares their certificates on social network sites such as LinkedIn, and the link back to the certificate is followed by some visitor to that social network site, the server emits an ``edx.certificate.evidence_visited`` event. **History**: Added 2 September 2015. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.certificate.evidence_visited`` event includes all of the same ``event`` member fields that are described for the ``edx.certificate.created`` event. The following member fields serve the same purpose for ``edx.certificate.evidence_visited`` as they do for ``edx.certificate.created``. * ``certificate_id`` * ``certificate_url`` * ``course_id`` * ``enrollment_mode`` * ``user_id`` The following additional ``event`` member fields apply specifically to ``edx.certificate.evidence_visited`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``social_network`` - string - The social network to which the certificate is shared, such as "LinkedIn", "Facebook", or "Twitter". * - ``source_url`` - string - The URL of the web site where the certificate evidence link was selected. This URL is the same as the URI in the ``context.referer`` field. For details, see :ref:`referer_field`. ======================================= ``edx.certificate.generation.enabled`` ======================================= This event is fired by the server when the self-generated (or student-generated) certificates feature is enabled for a course run. **History**: Added 14 July 2015 **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The course for which the self-generated certificates feature is being enabled for. ======================================== ``edx.certificate.generation.disabled`` ======================================== This event is fired by the server when the self-generated (or student-generated) certificates feature is disabled for a course run. **History**: Added 14 July 2015 **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The course for which the self-generated certificates feature is being disabled for. .. _student_cohort_events: *************************** Cohort Events (Student) *************************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 ================================= ``edx.cohort.created`` ================================= When a course team or the system creates a cohort, the server emits an ``edx.cohort.created`` event. Cohorts can be created manually by members of the course team. The system automatically creates the default cohort and any cohorts that are defined by the ``auto_cohort_groups`` advanced setting when they are needed (for example, when a student is assigned to one of those cohorts). Additional events are emitted when members of the course team select **Instructor** in the LMS to create a cohort on the instructor dashboard. See :ref:`instructor_cohort_events`. **History**: Added 7 Oct 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``cohort_id`` - number - The numeric ID of the cohort. * - ``cohort_name`` - string - The display name of the cohort. ================================= ``edx.cohort.user_added`` ================================= When a user is added to a cohort, the server emits an ``edx.cohort.user_added`` event. Members of the course team can add users to cohorts individually or by uploading a .csv file of student cohort assignments. The system automatically adds a user to the default cohort or a cohort included in the course's ``auto_cohort_groups`` setting if a user who has not yet been assigned to a cohort accesses course content. Additional events are emitted when members of the course team select **Instructor** in the LMS to add a user to a cohort on the instructor dashboard. See :ref:`instructor_cohort_events`. **History**: Added 7 Oct 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``cohort_id`` - number - The numeric ID of the cohort. * - ``cohort_name`` - string - The display name of the cohort. * - ``user_id`` - number - The numeric ID (from ``auth_user.id``) of the added user. ================================= ``edx.cohort.user_removed`` ================================= When a course team member selects **Instructor** in the LMS to change the cohort assignment of a learner on the instructor dashboard, the server emits an ``edx.cohort.user_removed`` event. **History**: Added 7 Oct 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``cohort_id`` - number - The numeric ID of the cohort. * - ``cohort_name`` - string - The display name of the cohort. * - ``user_id`` - number - The numeric ID (from ``auth_user.id``) of the removed user. .. _Course Content Completion Events: ************************************ Course Content Completion Event ************************************ This section describes the event emitted by the completion XBlock, which adds a toggle control in course content. This toggle allows learners to mark the associated section of course content as complete. EdX recommends using the completion XBlock primarily for progress tracking of ungraded activities, such as reading assigned texts, watching videos, or participating in course discussions. Learners are not limited in the number of times that they can toggle the control between the default incomplete state and the completed state. .. contents:: :local: :depth: 1 **History**: Added 27 Jan 2016. ======================================================= ``edx.done.toggled`` ======================================================= Both the browser and the server emit the ``edx.done.toggled`` event when the control added by the Completion XBlock is toggled. The ``event_source`` field indicates whether the event was emitted by the client or the server. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``done`` - Boolean - Indicates the state of the Completion toggle at the time the event is emitted. Possible values are ``true`` (a learner has completed the associated content) and ``false`` (a learner has not completed the associated content). .. _library_events: ************************************ Content Library Interaction Events ************************************ This section includes descriptions of the following events. .. contents:: :local: :depth: 1 Course teams in an organization can collaboratively contribute to content libraries, such as a collection of problem components for a particular subject. Content libraries are created and maintained separately from courses so that their content can be used in different courses. In a course outline, course teams can include randomized content block components that reference a content library and deliver its content to students. In a randomized content block component, the course team defines the type and number of content library components to deliver to each student. ===================================================== ``edx.librarycontentblock.content.assigned`` ===================================================== The server emits an ``edx.librarycontentblock.content.assigned`` event the first time that content from a randomized content block is delivered to a user. The ``edx.librarycontentblock.content.assigned`` event identifies the components delivered from the library to a user. Additional ``edx.librarycontentblock.content.assigned`` events can also be emitted if the course team makes a change that results in an increase in the number of components that the randomized content block delivers. After such a change, the randomized content block delivers more components to any user who revisits it after that change. For those users, the ``edx.librarycontentblock.content.assigned`` event identifies the complete set of components delivered from the library and also the components that were delivered for the first time. **History**: Added 18 Mar 2015. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``added`` - list - Lists the library components that were delivered to the user for the first time. The content of this field is different from the content of the ``result`` field only if the user revisited the randomized content block and it delivered additional components from the library. * - ``location`` - string - Identifies the randomized content block component. * - ``max_count`` - number - The **Count** specified by a course team member in Studio. Defines the number of library components to deliver. This number is greater than the number of library components listed by the ``result`` field only when the library has too few matching blocks available. * - ``previous_count`` - number - The number of components assigned to this student before this event. The first time the user views the randomized content block, this value is 0. * - ``result`` - list - Lists all of the library components delivered to the user. * ``descendants``, when present, is a list that identifies each part of a library component that contains multiple parts (the children of an XBlock with children). * ``original_usage_key`` and ``original_usage_version`` identify the component in the library. When students attempt a problem component delivered by a randomized content block, the resulting problem events also reference the ``original_usage_key`` and ``original_usage_version`` in ``context.module`` member fields. See :ref:`context`. * ``usage_key`` identifies the location of this component in the course. This value identifies a child of the randomized content block component. To identify a component consistently within a course, you can use either ``usage_key`` or ``original_usage_key`` as a consistent identifier. To identify components across courses, use ``orignal_usage_key``. ===================================================== ``edx.librarycontentblock.content.removed`` ===================================================== The server emits an ``edx.librarycontentblock.content.removed`` event when a user revisits a randomized content block and one or more of the components that were previously delivered to that user can no longer be delivered. * If components are removed from the library and the course team resynchronizes the randomized content block to the library, the server emits an ``edx.librarycontentblock.content.removed`` event if a user who was previously assigned one of those components revisits the randomized content block or accesses the progress page. * If the course team changes settings for the randomized content block so that fewer or different components are allowed. For example, the course team reduces the number of library components to deliver or specifies a different type of problem to deliver. **History**: Added 18 Mar 2015. **Event Source**: Server ``event`` **Member Fields**: The ``edx.librarycontentblock.content.removed`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the ``edx.librarycontentblock.content.assigned`` events. * ``location`` * ``max_count`` * ``previous_count`` * ``result`` The following additional ``event`` member fields apply specifically to ``edx.librarycontentblock.content.removed`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``reason`` - string - 'overlimit' if a course team member reduces the **Count** of library components to deliver. 'invalid' if the component is no longer included in the library, or no longer matches the settings specified for the randomized content block. * - ``removed`` - list - Identifies the components that are no longer delivered to this user. This field contains the same member fields as the ``event.result`` field for ``edx.librarycontentblock.content.assigned`` events. .. _navigational: *********************************** Course Navigation Events *********************************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 ============================================================================= ``edx.ui.lms.jump_nav.selected`` ============================================================================= The browser emits this event when a user selects a hyperlink using the breadcrumb jump navigation menus. **History**: Added Semptember 20 2021. **Component**: Sequence **Event Source**: Browser ``event`` **Member Fields**: The ``edx.ui.lms.link_clicked`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``target_name`` - string - The string title of the intended destination of the navigation. * - ``id`` - string - the block id of the intended destination of the navigation. * - ``current_id`` - string - The block id of the current unit block before navigating away. * - ``widget_placement`` - string - The location on the browser the event originates from. ============================================================================= Example ``edx.ui.lms.jump_nav.selected`` Event ============================================================================= The following example shows the relevant fields of the event that is emitted when a user selects any hypertext link from the course breadcrumb content. .. code-block:: json { "name": "edx.ui.lms.jump_nav.selected", "event": { "target_name": "Part 3: Getting Social" "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@simulations/block-v1:edX+DemoX+Demo_Course+type@vertical+block@d0d804e8863c4a95a659c04d8a2b2bc0", "current_id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@basic_questions/block-v1:edX+DemoX+Demo_Course+type@vertical+block@2152d4a4aadc4cb0af5256394a3d1fc7", "widget_placement": "breadcrumb" } } ============================================================================= ``edx.ui.lms.link_clicked`` ============================================================================= The browser emits this event when a user selects any hypertext link from the course content. **History**: Added May 5 2016. **Component**: Sequence **Event Source**: Browser ``event`` **Member Fields**: The ``edx.ui.lms.link_clicked`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``current_url`` - string - The URL of the page where the user selected the hypertext link. * - ``target_url`` - string - The URL of the page that the selected link leads to. ============================================================================= Example ``edx.ui.lms.link_clicked`` Event ============================================================================= The following example shows the relevant fields of the event that is emitted when a user selects any hypertext link from the course content. .. code-block:: json { "name": "edx.ui.lms.link_clicked", "event_type": "edx.ui.lms.link_clicked", "event": { "target_url": "http://example-website.com", "current_url": "https://courses.edx.org/courses/a/course/here/some/further/info", } } =========================================== ``edx.ui.lms.outline.selected`` =========================================== The browser emits this event when a user selects a subsection in the course navigation pane in the LMS to open a new page. Selecting a section in the course navigation pane does not emit an event. **History**: Added May 5 2016. **Component**: Sequence **Event Source**: Browser ``event`` **Member Fields**: The ``edx.ui.lms.sequence.outline.selected`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``current_url`` - string - The URL of the page where the user is viewing the course navigation pane. * - ``target_name`` - string - The display name of the subsection that the user is navigating to, on the page identified by ``target_url``. * - ``target_url`` - string - The URL of the page containing the subsection that the user is navigating to. * - ``widget_placement`` - string - Indicates the position on the page of the control that the user selected. For this event, the control is the course navigation pane at the side of the course page, identified with a value of ``accordion``. ================================================ Example ``edx.ui.lms.outline.selected`` Event ================================================ The following example shows the relevant fields of the event that is emitted when a user selects a subsection on the course navigation pane in the LMS. .. code-block:: json { "name": "edx.ui.lms.outline.selected", "event_type": "edx.ui.lms.outline.selected", "event": { "target_name": "Lesson 3 - Be Social ", "target_url": "https://courses.stage.edx.org/courses/edX/DemoX/Demo_Course/courseware/social_integration/48ecb924d7fe4b66a230137626bfa93e/", "widget_placement": "accordion", "current_url": "https://courses.stage.edx.org/courses/edX/DemoX/Demo_Course/courseware/graded_interactions/simulations/" } } ================================================ ``edx.ui.lms.sequence.next_selected`` ================================================ The browser emits this event when a user selects the "next" control in the unit navigation bar in the LMS. Users can use the "next" control to navigate from one unit to the next unit within the current subsection, or from the last unit in one subsection to the first unit in the next subsection. **History**: On May 3, 2016, the "next" navigation control in the LMS was enhanced to allow users to move not only within a subsection but also between subsections. The ``seq_next`` event was correspondingly enhanced with additional fields and now maps to the new event ``edx.ui.lms.sequence.next_selected``. Before May 3, 2016, the ``name`` and ``event`` fields for the ``seq_next`` event were both set to the same value. Events that have both a ``name`` and an ``event_type`` of ``seq_next`` are no longer emitted. The new event with a ``name`` value of ``edx.ui.lms.sequence.next_selected`` is emitted when users navigate in the LMS using the "next" control. Depending on whether a learner navigates within the current subsection or between subsections, the resulting event has a different ``event_type`` value. * Navigating to the next unit within a subsection (the already supported interaction that previously emitted the ``seq_next`` event) now emits the new event with an ``event_type`` of ``seq_next``, so that you can continue to track the same interaction. * Navigating from the last unit in one subsection to the first unit in the next subsection, which is the newly supported interaction, emits the new event with both an ``event_type`` and ``name`` of ``edx.ui.lms.sequence.next_selected``. **Component**: Sequence **Event Source**: Browser The ``edx.ui.lms.sequence.next_selected`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``current_tab`` - integer - Identifies the tab or icon in the unit navigation bar that the user was viewing prior to selecting "next". Tabs correspond to the unit in the subsection (or verticals in the sequence) and are indexed starting from 1. If this value is equal to ``tab_count``, the user was on the last vertical of the subsection. * - ``id`` - string - The usage key of the subsection that is being navigated by the user. * - ``new`` - integer - Identifies the tab that the user was navigating to. This field is included only for events that are emitted by "next" navigation within a subsection. These events have an ``event_type`` of ``seq_next`` to enable backward compatibility with the ``seq_next`` events emitted prior to 3 May 2016. * - ``old`` - integer - Identifies the tab that the user was navigating from. This field is included only for events that are emitted by "next" navigation within a subsection. These events have an ``event_type`` of ``seq_next`` to enable backward compatibility with the ``seq_next`` events emitted prior to 3 May 2016. The ``edx.ui.lms.sequence.next_selected`` events emitted after 3 May 2016 use the ``current_tab`` value to identify the user's position in the unit, and do not include this field. * - ``tab_count`` - integer - The number of tabs in the unit navigation bar. This number matches the total number of units in the current subsection. * - ``widget_placement`` - string - Unit navigation controls appear at the top and bottom of pages in the LMS. Values for this field can be "top" or "bottom", indicating the position on the page of the control that the user selected. ===================================================== Example ``edx.ui.lms.sequence.next_selected`` Events ===================================================== The following example shows the relevant fields in the event that is emitted when a user navigates within the same subsection using the "next" control. .. code-block:: json { "name": "edx.ui.lms.sequence.next_selected", "event_type": "seq_next", "event": { "current_tab": 3, "tab_count": 6 "old": 3, "new": 4, "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@19a30717eff543078a5d94ae9d6c18a5", "widget_placement": "top" } } The following example shows the relevant fields in the event that is emitted when a user navigates from the last unit in one subsection to the first unit in the next subsection using the "next" control. .. code-block:: json { "name": "edx.ui.lms.sequence.next_selected", "event_type": "edx.ui.lms.sequence.next_selected", "event": { "current_tab": 6, "tab_count": 6, "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@19a30717eff543078a5d94ae9d6c18a5", "widget_placement": "top" } } ===================================================== ``edx.ui.lms.sequence.previous_selected`` ===================================================== The browser emits this event when a user selects the "previous" control in the unit navigation bar in the LMS. Users can use the "previous" control to navigate from one unit back to the previous unit within the current subsection, or from the first unit in one subsection to the last unit in the previous subsection. **History**: On May 3, 2016, the "previous" navigation control in the LMS was enhanced to allow users to move not only within a subsection but also between subsections. The ``seq_prev`` event was correspondingly enhanced with additional fields and now maps to the new event ``edx.ui.lms.sequence.previous_selected``. Before May 3 2016, the ``name`` and ``event`` fields for the ``seq_prev`` event were both set to the same value. Events that have both a ``name`` and an ``event_type`` of ``seq_prev`` are no longer emitted. After May 3 2016, an event that has a ``name`` value of ``edx.ui.lms.sequence.previous_selected`` is emitted when users navigate in the LMS using the "previous" control. Depending on whether a learner navigates within the current subsection or between subsections, the resulting event has a different ``event_type`` value. * Navigating to the previous unit within a subsection (the already supported interaction that previously emitted the ``seq_prev`` event) now emits the new event with an ``event_type`` of ``seq_prev``, so that you can continue to track the same interaction. * Navigating from the first unit in one subsection to the last unit in the previous subsection, which is the newly supported interaction, emits the new event with both an ``event_type`` and ``name`` of ``edx.ui.lms.sequence.previous_selected``. **Component**: Sequence **Event Source**: Browser The ``edx.ui.lms.sequence.previous_selected`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: The ``edx.ui.lms.sequence.previous_selected`` event also includes the following ``event`` member fields. These fields serve the same purpose for events of this type as for ``edx.ui.lms.sequence.next_selected`` events. * ``current_tab`` * ``id`` * ``new`` * ``old`` * ``tab_count`` * ``widget_placement`` ========================================================== Example ``edx.ui.lms.sequence.previous_selected`` Events ========================================================== The following example shows the relevant fields in the event that is emitted when a user navigates within the same subsection using the "previous" control. .. code-block:: json { "name": "edx.ui.lms.sequence.previous_selected", "event_type": "seq_prev", "event": { "current_tab": 2, "tab_count": 6 "old": 2, "new": 1, "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@19a30717eff543078a5d94ae9d6c18a5", "widget_placement": "top" } } The following example shows the relevant fields in the event that is emitted when a user navigates from the first unit in one subsection to the last unit in the previous subsection using the "previous" control. .. code-block:: json { "name": "edx.ui.lms.sequence.previous_selected", "event_type": "edx.ui.lms.sequence.previous_selected", "event": { "current_tab": 1, "tab_count": 6, "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@19a30717eff543078a5d94ae9d6c18a5", "widget_placement": "top" } } ========================================================== ``edx.ui.lms.sequence.tab_selected`` ========================================================== The browser emits this event when a user selects any tab in the unit navigation bar in the LMS to navigate to another unit within the subsection. Tabs correspond to the unit in the subsection (or verticals in the sequence). **History**: On May 3, 2016, the ``seq_goto`` event was promoted to a new naming infrastructure and now maps to the new event ``edx.ui.lms.sequence.tab_selected``. Before May 3, 2016, the ``name`` and ``event`` fields for the ``seq_goto`` event were both set to the same value. New fields have been added to the event, but existing fields are retained for backward compatibility. The updated event has a ``name`` value of ``edx.ui.lms.sequence.tab_selected`` and an ``event_type`` value of ``seq_goto``, to ensure that you can map these new events to the ``seq_goto`` events that were emitted previously. Events that have both a ``name`` and an ``event_type`` of ``seq_goto`` are no longer emitted. **Component**: Sequence **Event Source**: Browser The ``edx.ui.lms.sequence.tab_selected`` event includes both a ``name`` field and an ``event_type`` field. For more information about these common fields, see :ref:`common`. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``target_tab`` - integer - Identifies the tab or icon in the unit navigation bar that the user selected to navigate to. Tabs correspond to the unit in the subsection, and are indexed starting from 1. The ``edx.ui.lms.sequence.tab_selected`` event also includes the following ``event`` member fields. These fields serve the same purpose for events of this type as for ``edx.ui.lms.sequence.next_selected`` events. * ``current_tab`` * ``id`` * ``new`` * ``old`` * ``tab_count`` * ``widget_placement`` ========================================================== Example ``edx.ui.lms.sequence.tab_selected`` Event ========================================================== .. code-block:: json { "name": "edx.ui.lms.sequence.tab_selected", "event_type": "seq_goto", "event": { "current_tab": 3, "target_tab": 7, "tab_count": 7, "old": 3, "new": 7, "id": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@19a30717eff543078a5d94ae9d6c18a5", "widget_placement": "top" } } ``page_close`` ************** The ``page_close`` event originates from within the JavaScript Logger itself. **Component**: JavaScript Logger **Event Source**: Browser ``event`` **Member Fields**: None .. _course_resources: ************************** Course Resource Events ************************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 Course resource events are emitted when a user interacts with a course resource or tool, such as the Course Reviews tool or the Bookmarks tool. .. _edx_bookmark_accessed: ===================================================== ``edx.bookmark.accessed`` ===================================================== The browser emits this event when a user accesses a bookmark by selecting a link on the **My Bookmarks** page in the LMS. **History**: Added 4 Jan 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``bookmark_id`` - string - The unique internal identifier for the bookmark. * - ``component_type`` - string - The component type of the bookmarked XBlock. * - ``component_usage_id`` - string - The unique usage identifier of the bookmarked XBlock. This ID corresponds to the ``courseware_studentmodule.module_id``. .. _edx_bookmark_added: ===================================================== ``edx.bookmark.added`` ===================================================== The server emits this event when a user bookmarks a page in the course. **History**: Added 4 Jan 2016. **Event Source**: Server ``event`` **Member Fields**: The ``edx.course.bookmark.added`` events include the same event member fields that are described for :ref:`edx_bookmark_accessed`. The following member fields serve the same purpose for accessed bookmarks, added bookmarks, and removed bookmarks. * ``bookmark_id`` * ``component_type`` * ``component_usage_id`` The following ``event`` member field applies specifically to ``edx.course.bookmark.added`` and ``edx.course.bookmark.removed`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The identifier of the course that includes the bookmark. .. _edx_bookmark_listed: ===================================================== ``edx.bookmark.listed`` ===================================================== The server emits this event when a user clicks **Bookmarks** under the **Course Tools** heading in the LMS to view the list of previously bookmarked pages. If the number of bookmarks exceeds the defined page length, the browser emits an additional ``edx.course.bookmark.listed`` event each time the user navigates to a different page of results. See also :ref:`course_tool_accessed`. **History**: Added 4 Jan 2016. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``bookmarks_count`` - integer - The number of pages a learner has bookmarked. If ``course_id`` is specified, this value is the number of pages that a learner has bookmarked in that course. * - ``course_id`` - string - The identifier of the course that includes the bookmark. This is an optional field that is present only if the value for ``list_type`` is ``per_course``. * ``per_course`` indicates that all listed bookmarks are in a single course. * ``all_courses`` indicates that the listed bookmarks can be in any course that the learner is enrolled in. * - ``list_type`` - string - Possible values are ``per_course`` or ``all_courses``. * - ``page_number`` - integer - The current page number in the list of bookmarks. * - ``page_size`` - integer - The number of bookmarks on the current page. ===================================================== ``edx.bookmark.removed`` ===================================================== The server emits this event when a user removes a bookmark from a page. **History**: Added 4 Jan 2016. **Event Source**: Server ``event`` **Member Fields**: The ``edx.course.bookmark.removed`` event includes the same event member fields that are described for :ref:`edx_bookmark_accessed`, and it also includes the ``course_id`` field that is described for :ref:`edx_bookmark_added`. The ``edx.course.bookmark.removed`` event includes the following event member fields. * ``bookmark_id`` * ``component_type`` * ``component_usage_id`` * ``course_id`` .. _course_tool_accessed: ===================================================== ``edx.course.tool.accessed`` ===================================================== The browser emits an ``edx.course.tool.accessed`` event when a user clicks one of the links under the **Course Tools** heading in the LMS, such as **Bookmarks**, **Reviews**, or **Updates**. See also :ref:`edx_bookmark_listed`. **History**: Added 24 July 2017. **Component**: LMS **Event Source**: Browser In addition to the :ref:`common` ``context`` and ```event`` member fields, this event type also includes the following ``event`` member fields. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``tool_name`` - string - The name of the course tool that was accessed. Possible values are ``edx.bookmarks``, ``edx.reviews``, and ``edx.updates``. .. _forum_events: ************************** Discussion Forum Events ************************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 The server emits discussion forum events when a user interacts with a course discussion. This section presents the discussion forum events alphabetically. However, several of these events have hierarchical or sequential relationships. * When a user creates a new thread, such as a student asking a question, the server emits an :ref:`forum_thread` event. * When a user responds to a thread, such as another student answering the question, the server emits an :ref:`forum_response` event. * When a user adds a comment to a response, such as a course team member adding a clarification to the student answer, the server emits an :ref:`forum_comment` event. These events are emitted and included in daily event logs in addition to the MongoDB discussion forums database data that is included in the weekly database data files. If a thread, response, or comment was part of a team discussion within a course, a ``team_id`` field is also included in events for creation or voting interactions. The ``team_id`` identifies the team that triggered the discussion event. For more information about events for teams, see :ref:`student_teams_events`. .. _forum_comment: ===================================================== ``edx.forum.comment.created`` ===================================================== Users create a comment about a response by entering text and then submitting the contributions. When these actions are complete, the server emits an ``edx.forum.comment.created`` event. **History**: Added 5 Mar 2015. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.created`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` and :ref:`forum_response` events. The following member fields serve the same purpose for comments as they do for threads or responses. * ``body`` * ``commentable_id`` * ``discussion`` * ``id`` * ``options`` * ``team_id`` * ``truncated`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``response`` - object - Contains a member ``id`` field with the unique identifier of the response that the user added this comment to. ===================================================== ``edx.forum.comment.edited`` ===================================================== Users edit a comment about a response by entering text and then submitting the contributions. When these actions are complete, the server emits an ``edx.forum.comment.edited`` event. **History**: Added for Discussions MFE on 3 Oct 2022, added for legacy forums 21 Nov 2022 **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.edited`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` and :ref:`forum_response` events. The following member fields serve the same purpose for comments as they do for threads or responses. * ``commentable_id`` * ``category_id`` * ``category_name`` * ``content_type`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following member fields serve the same purpose for threads as they do for comments: * ``target_username`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``edit_reason`` - string - Identifies the reason selected for the edit. * - ``own_content`` - boolean - Identifies whether the user is the author of the comment. * - ``content_type`` - string - Identifies the type of content. Possible values are 'post', 'comment', 'response'. ===================================================== ``edx.forum.comment.deleted`` ===================================================== Users delete a comment about a response by clicking **Delete** and then clicking **Delete** again to confirm the deletion. When these actions are complete, the server emits an ``edx.forum.comment.deleted`` event. **History**: Added 21 Sept 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.deleted`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` and :ref:`forum_response` events. The following member fields serve the same purpose for comments as they do for threads or responses. * ``body`` * ``commentable_id`` * ``content_type`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` ===================================================== ``edx.forum.comment.reported`` ===================================================== Users can report a comment as inappropriate. When this action is taken the ``edx.forum.comment.reported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.reported`` events include many of the same ``event`` member fields that are described for :ref:`forum_comment` events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` * ``content_type`` ===================================================== ``edx.forum.comment.unreported`` ===================================================== Users can report a comment as inappropriate, they can also undo this action. When a thread is un-reported the ``edx.forum.comment.unreported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.unreported`` events include many of the same ``event`` member fields that are described for :ref:`forum_comment` events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` * ``truncated`` * ``content_type`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``reported_status_cleared`` - Boolean - TRUE if the reported status of the content is cleared, otherwise FALSE. Note that reported status is only removed when: 1. A user with moderation role un-reports content. 2. All users without moderation roles, who reported the content, have un-reported it. .. _forum_response: ===================================================== ``edx.forum.response.created`` ===================================================== Users create a reply to a post by clicking **Add a Response** and then submitting their contributions. When these actions are complete, the server emits an ``edx.forum.response.created`` event. **History**: Added 5 Mar 2015. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.created`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for responses as they do for threads. * ``body`` * ``commentable_id`` * ``id`` * ``options`` * ``team_id`` * ``truncated`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following additional ``event`` member field applies specifically to ``edx.forum.response.created`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``discussion`` - object - Contains a member ``id`` field with the unique identifier of the thread that the user responded to. Also present for ``edx.forum.comment.created`` events. ===================================================== ``edx.forum.response.deleted`` ===================================================== Users delete a response about a response by clicking **Delete** and then clicking **Delete** again to confirm the deletion. When these actions are complete, the server emits an ``edx.forum.response.deleted`` event. **History**: Added 21 Sept 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.comment.deleted`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` and :ref:`forum_response` events. The following member fields serve the same purpose for comments as they do for threads or responses. * ``body`` * ``commentable_id`` * ``content_type`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` ===================================================== ``edx.forum.response.edited`` ===================================================== Users edit a response by entering text and then submitting the contributions. When these actions are complete, the server emits an ``edx.forum.response.edited`` event. **History**: Added for Discussions MFE on 3 Oct 2022, added for legacy forums 21 Nov 2022 **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.edited`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for responses as they do for threads. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``content_type`` The following member fields serve the same purpose for responses as they do for comments: * ``target_username`` * ``edit_reason`` * ``own_content`` * ``content_type`` ===================================================== ``edx.forum.response.mark`` ===================================================== Users are able to mark a comment as "endorsed" or "answered". When they do this the ``edx.forum.response.mark`` event is emitted. **History**: 5 Dec 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.mark`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for responses as they do for threads or comments. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``discussion.id`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``mark_type`` - string - Indicates the type of mark added. Either ``Endorse`` or ``Answer`` ===================================================== ``edx.forum.response.unmark`` ===================================================== Users are able to mark a comment as "endorsed" or "answered", they may also undo that action by "unmarking". When this happens ``edx.forum.response.unmark`` is emitted. **History**: 5 Dec 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.unmark`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``discussion.id`` The following member fields serve the same purpose for responses as they do for response marks: * ``mark_type`` ===================================================== ``edx.forum.response.reported`` ===================================================== Users can report a response as inappropriate. When this action is taken the ``edx.forum.response.reported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.reported`` events include many of the same ``event`` member fields that are described for :ref:`forum_response` events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``discussion.id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` * ``content_type`` ===================================================== ``edx.forum.response.unreported`` ===================================================== Users can report a response as inappropriate, they can also undo this action. When a thread is un-reported the ``edx.forum.response.unreported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.unreported`` events include many of the same ``event`` member fields that are described for :ref:`forum_response` events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``discussion.id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``reported_status_cleared`` - Boolean - TRUE if the reported status of the content is cleared, otherwise FALSE. Note that reported status is only removed when: 1. A user with moderation role un-reports content. 2. All users without moderation roles, who reported the content, have un-reported it. ===================================================== ``edx.forum.response.voted`` ===================================================== Users can indicate interest in a response by selecting a "Vote" icon. The "Vote" icon is a toggle, so users can also clear a vote made previously. When either of these actions is complete, the server emits an ``edx.forum.response.voted`` event. In these events, the user who voted for the response is identified in the ``username`` and ``context.user_id`` fields, and the user who originally posted the thread is identified in the ``event.target_username`` field. **History**: Added 1 Dec 2015. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.response.voted`` events include the same ``event`` member fields as :ref:`edx.forum.thread.voted` events. The following member fields serve the same purpose for votes on a response as they do for votes on a thread. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``target_username`` * ``team_id`` * ``undo_vote`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``vote_value`` ===================================================== ``edx.forum.searched`` ===================================================== After a user executes a text search in the navigation sidebar of the course **Discussion** page, the server emits an ``edx.forum.searched`` event. **History**: Added 16 May 2014. The ``corrected_text`` field was added 5 Jun 2014. The ``group_id`` field was added 7 October 2014. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``corrected_text`` - string - A re-spelling of the query, suggested by the search engine, which was automatically substituted for the original one. This happens only when there are no results for the original query, but the index contains matches for a similar term or phrase. Otherwise, this field is null. * - ``group_id`` - number - The numeric ID of the cohort to which the user's search is restricted, or ``null`` if the search is not restricted in this way. In a course with cohorts enabled, a student's searches will always be restricted to the student's cohort. Discussion admins, moderators, and Community TAs in such a course can search all discussions without specifying a cohort, which leaves this field ``null``, or they can specify a single cohort to search. * - ``page`` - number - Results are returned in sets of 20 per page. Identifies the page of results requested by the user. * - ``query`` - string - The text entered into the search box by the user. * - ``total_results`` - number - The total number of results matching the query. .. _forum_thread: ===================================================== ``edx.forum.thread.created`` ===================================================== Users create a new top-level thread, also known as a post, by clicking **New Post** and then submitting their contributions. When these actions are complete, the server emits an ``edx.forum.thread.created`` event. **History**: Added 5 Mar 2015. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``anonymous`` - Boolean - Applies only to courses that allow discussion posts that are anonymous to all other users. 'true' only if the user selected the **post anonymously** check box. * - ``anonymous_to_peers`` - Boolean - Applies only to courses that allow discussion posts that are anonymous to other students. The username of the thread creator is visible only to users who have discussion management privileges. 'true' only if the user selected the **post anonymously to classmates** check box. * - ``body`` - string - The text supplied for the new post. Truncated if the field contains more than 2000 characters. Also present for ``edx.forum.response.created`` and ``edx.forum.comment.created`` events. * - ``category_id`` - string - Identifier for the specific discussion component or top-level, course-wide discussion. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, ``edx.forum.response.voted``, ``edx.forum.thread.viewed``, and ``edx.forum.thread.voted`` events. * - ``category_name`` - string - The display name for the specific discussion component or top-level, course-wide discussion. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, ``edx.forum.response.voted``, ``edx.forum.thread.viewed``, and ``edx.forum.thread.voted`` events. * - ``commentable_id`` - string - Identifier for the specific discussion component or top-level, course-wide discussion. Duplicates the ``category_id``. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, and ``edx.forum.thread.viewed`` events. * - ``group_id`` - string - The numeric ID of the cohort to which the contribution is restricted, or ``null`` if the contribution is not restricted to a specific cohort. * - ``id`` - string - A unique identifier for this forum contribution. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, and ``edx.forum.thread.viewed`` events. * - ``options`` - object - Contains the ``followed`` Boolean, which identifies whether the user elected to track the responses that others make to this post. Also present for ``edx.forum.response.created`` and ``edx.forum.comment.created`` events. * - ``team_id`` - string - If the thread is part of a team discussion within a course, this field identifies the team that the thread was created in. For more information about events for teams, see :ref:`student_teams_events`. Also present for ``edx.forum.thread.viewed`` events. * - ``thread_type`` - string - The person who creates the thread specifies either 'discussion' or 'question' to characterize the purpose of the post. * - ``title`` - string - The brief descriptive text supplied to identify the post. Truncated if the title has more than 1000 characters. * - ``title_truncated`` - Boolean - 'true' only if the title is longer than 1000 characters, which is the maximum included in the event. * - ``truncated`` - Boolean - 'true' only if the post contains more than 2000 characters, which is the maximum included in the event. Also present for ``edx.forum.response.created`` and ``edx.forum.comment.created`` events. * - ``url`` - string - The escaped URL of the page from which the thread can be viewed. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, and ``edx.forum.thread.viewed`` events. * - ``user_course_roles`` - array - Identifies the course-level 'Instructor' (that is, Admin) or 'Staff' privilege assigned to the user. No value is reported for students. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, and ``edx.forum.thread.viewed`` events. The ``student_courseaccessrole`` table lists all users who have a privileged role for the course. * - ``user_forums_roles`` - array - Identifies a user who does not have discussion management privileges as a 'Student'. Identifies users who have discussion management privileges as a course 'Community TA', 'Moderator', or 'Administrator'. Also present for ``edx.forum.response.created``, ``edx.forum.comment.created``, and ``edx.forum.thread.viewed`` events. The ``django_comment_client_role_users`` table lists the discussion role of every enrolled user. ===================================================== ``edx.forum.thread.deleted`` ===================================================== Users deleted a top-level thread by clicking **Delete** and then confirming the deletion. When this actions are complete, the server emits an ``edx.forum.thread.deleted`` event. **History**: Added 21 Sept 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.deleted`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for thread edits as they do for comment edition. * ``body`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``team_id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``title`` * ``title_truncated`` The following member fields serve the same purpose for threads as they do for comments: * ``target_username`` * ``edit_reason`` * ``own_content`` * ``content_type`` ===================================================== ``edx.forum.thread.edited`` ===================================================== Users edit a top-level thread by clicking **Edit** and then submitting their changes. When these actions are complete, the server emits an ``edx.forum.thread.edited`` event. **History**: Added for Discussions MFE on 3 Oct 2022, added for legacy forums 21 Nov 2022 **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.edited`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for thread edits as they do for comment edition. * ``commentable_id`` * ``category_id`` * ``category_name`` * ``content_type`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` * ``content_type`` The following member fields serve the same purpose for threads as they do for comments: * ``target_username`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``edit_reason`` - string - Identifies the reason selected for the edit. * - ``own_content`` - boolean - Identifies whether the user is the author of the comment. * - ``content_type`` - string - Identifies the type of content. Possible values are 'post', 'comment', 'response'. ===================================================== ``edx.forum.thread.locked`` ===================================================== Users closes a top-level thread by clicking **Close** and then confirming the action. When these actions are complete, the server emits an ``edx.forum.thread.locked`` event. **History**: Added 15 Sept 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.locked`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for thread edits as they do for comment edition. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``team_id`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following member fields serve the same purpose for responses as they do for comments: * ``target_username`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``lock_reason`` - string - The reason that the thread was locked. ===================================================== ``edx.forum.thread.reported`` ===================================================== Users can report a comment thread as inappropriate. When this action is taken the ``edx.forum.thread.reported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.reported`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` * ``title`` * ``title_truncated`` * ``content_type`` ===================================================== ``edx.forum.thread.unlocked`` ===================================================== Users reopens a top-level thread by clicking **Reopen** and then confirming the action. When these actions are complete, the server emits an ``edx.forum.thread.unlocked`` event. **History**: Added 15 Sept 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.unlocked`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for thread edits as they do for comment edition. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``team_id`` * ``id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following member fields serve the same purpose for thread unlocks as they do for comments: * ``target_username`` The following member fields serve the same purpose for thread unlocks as they do for thread locks: * ``lock_reason`` ===================================================== ``edx.forum.thread.unreported`` ===================================================== Users can report a comment thread as inappropriate, they can also undo this action. When a thread is un-reported the ``edx.forum.thread.unreported`` is emitted. **History**: Added 1 Nov 2022. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.unreported`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose as other thread events. * ``id`` * ``url`` * ``category_id`` * ``category_name`` * ``commentable_id`` * ``user_course_roles`` * ``user_forums_roles`` * ``target_username`` * ``body`` * ``title`` * ``title_truncated`` * ``content_type`` .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``reported_status_cleared`` - Boolean - TRUE if the reported status of the content is cleared, otherwise FALSE. Note that reported status is only removed when: 1. A user with moderation role un-reports content. 2. All users without moderation roles, who reported the content, have un-reported it. .. _edx.forum.thread.viewed: ===================================================== ``edx.forum.thread.viewed`` ===================================================== A user views a thread in the course discussions on a desktop, laptop, or tablet computer, or on the edX mobile apps. **History**: Added 12 Jul 2017. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.viewed`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for thread views as they do for thread creation. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``team_id`` * ``title`` * ``title_truncated`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following additional ``event`` member field applies to ``edx.forum.thread.viewed`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``target_username`` - string - Identifies the user who originally posted the thread. This member field has the following limitations. * For browser views, the ``edx.forum.thread.viewed`` event includes the ``target_username`` field for all posts, including anonymous posts. * For views on versions of the edX mobile apps earlier than 2.9.1 for iOS and 2.8.1 for Android, the ``edx.forum.thread.viewed`` event does not include the ``target_username`` field. * For views on versions of the edX mobile apps later than 2.9.1 for iOS and 2.8.1 for Android, the ``edx.forum.thread.viewed`` event includes the ``target_username`` field for non-anonymous posts only. .. _edx.forum.thread.voted: ===================================================== ``edx.forum.thread.voted`` ===================================================== Users can indicate interest in a thread by selecting a "Vote" icon. The "Vote" icon is a toggle, so users can also clear a vote made previously. When either of these actions is complete, the server emits an ``edx.forum.thread.voted`` event. In these events, the user who voted for the thread is identified in the ``username`` and ``context.user_id`` fields, and the user who originally posted the thread is identified in the ``event.target_username`` field. **History**: Added 1 Dec 2015. **Component**: Discussion **Event Source**: Server ``event`` **Member Fields**: The ``edx.forum.thread.voted`` events include many of the same ``event`` member fields that are described for :ref:`forum_thread` events. The following member fields serve the same purpose for votes on a thread as they do for thread creation. * ``category_id`` * ``category_name`` * ``commentable_id`` * ``id`` * ``team_id`` * ``url`` * ``user_course_roles`` * ``user_forums_roles`` The following additional ``event`` member fields apply to ``edx.forum.thread.voted`` events. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``target_username`` - string - Identifies the user who originally posted the thread, even if the user posted anonymously. Also present for ``edx.forum.response.voted`` events, where it indicates the user who originally made the response. * - ``undo_vote`` - Boolean - 'true' if the user clears selection of the "Vote" icon made previously. 'false' if the user selects the "Vote" icon. Also present for ``edx.forum.response.voted`` events. * - ``vote_value`` - string - Set to 'up' for all ``edx.forum.thread.voted`` events. In the user interface, users can only vote for ("up vote") a thread or clear a previous vote. They cannot vote against ("down vote") a thread. Also present for ``edx.forum.response.voted`` events .. _Drag and Drop Events: *********************** Drag and Drop Events *********************** This section describes events emitted by the drag and drop problem XBlock. The drag and drop problem XBlock presents a background image and a set of draggable items. Learners select an item and move it into a target zone on the background image. Drag and drop problems can also require that learners enter number input for each item that they drag into a target zone. A drag and drop problem is complete when each draggable item that matches a target zone is correctly placed on its zone. .. contents:: :local: :depth: 1 This section presents the drag and drop events alphabetically. Typically, an interaction with these problems begins with a :ref:`drag_and_drop_v2_loaded` event. **History**: Added 24 Feb 2016. ======================================================= ``edx.drag_and_drop_v2.feedback.closed`` ======================================================= The server emits this event when a pop up feedback message closes in a drag and drop problem. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``content`` - string - The text of the success or error feedback message in the pop up. * - ``manually`` - Boolean - 'true' if the learner manually closed the pop up dialog box, 'false' if the browser closed the dialog box. * - ``truncated`` - Boolean - 'true' only if the ``content`` was longer than 12,500 characters, which is the maximum included in the event. ======================================================= ``edx.drag_and_drop_v2.feedback.opened`` ======================================================= The server emits this event when a pop up feedback message opens in a drag and drop problem. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: The ``edx.drag_and_drop_v2.feedback.opened`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for ``edx.drag_and_drop_v2.feedback.closed`` events. * ``content`` * ``truncated`` ======================================================= ``edx.drag_and_drop_v2.item.dropped`` ======================================================= The server emits this event when a learner releases a draggable item into a target zone in a drag and drop problem. For problems that also require a number input, this event is also emitted after the learner submits the number input. **Event Source**: Server **History**: ``item`` and ``location_id`` added 7 Sep 2016. ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``input`` - integer - The number input value entered by the learner. * - ``item`` - string - The display name of the draggable item selected by the learner. For items that do not have a display name, this contains the item's image URL. * - ``item_id`` - integer - The index assigned to the draggable item selected by the learner. * - ``is_correct`` - Boolean - For problems that do not require a number input, 'true' if the item is in the correct zone, or 'false' if it is not in a correct zone. For problems that require a number input, 'true' only if both the item is dropped in the correct zone and the number input is correct. * - ``is_correct_location`` - Boolean - 'true' if the draggable item is in the correct target zone. 'false' if the item is not in the correct zone. For problems that do not require a number input, ``is_correct`` and ``is_correct_location`` are equivalent. * - ``location`` - string - The text identifier for the target zone in which the learner placed the item. * - ``location_id`` - integer - The automatically generated unique index assigned to the target zone in which the learner placed the item. The assigned index is persistent for each instance. ======================================================= ``edx.drag_and_drop_v2.item.picked_up`` ======================================================= The server emits this event when a learner selects a draggable item in a drag and drop problem. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``item_id`` - integer - The index assigned to the draggable item selected by the learner. .. _drag_and_drop_v2_loaded: ======================================================= ``edx.drag_and_drop_v2.loaded`` ======================================================= The server emits this event after a drag and drop problem is shown in the LMS. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: None .. _enrollment: ***************** Enrollment Events ***************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 ============================================================================= ``edx.course.enrollment.activated`` and ``edx.course.enrollment.deactivated`` ============================================================================= The server emits these events in response to course enrollment activities completed by a student. * When a student enrolls in a course, the server emits an ``edx.course.enrollment.activated`` event. For example, when a student clicks **Enroll** for a course on the edx.org site, the server emits this event. * When a student unenrolls from a course, the server emits an ``edx.course.enrollment.deactivated`` event. For example, when a student clicks **Unenroll** for a course on the edx.org site, the server emits this event. In addition, actions by course team members also generate enrollment events. For the actions that members of the course team complete that result in these events, see :ref:`instructor_enrollment`. **History**: These enrollment events were added on 03 Dec 2013. On 07 May 2014, the ``name`` field was added. These enrollment events include both a ``name`` field and an ``event_type`` field. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The course in which the student was enrolled or unenrolled. If an external tool is used to enroll or unenroll students, this field contains a value and the ``context.course_id`` field is null. * - ``mode`` - string - 'audit', 'honor', 'professional', 'verified'. Identifies the student's enrollment mode. * - ``user_id`` - number - Identifies the student who was enrolled or unenrolled. ======================================================== Example ``edx.course.enrollment.deactivated`` Event ======================================================== .. code-block:: json { "username": "AAAAAAAAAA", "event_source": "server", "name": "edx.course.enrollment.deactivated", "referer": "http:\/\/localhost:8001\/container\/i4x:\/\/edX\/DemoX\/vertical\/69dedd38233a46fc89e4d7b5e8da1bf4?action=new", "accept_language": "en-US,en;q=0.8", "time": "2014-01-26T00:28:28.388782+00:00", "agent": "Mozilla\/5.0 (Windows NT 6.1; WOW64; Trident\/7.0; rv:11.0) like Gecko", "page": null "host": "courses.edx.org", "session": "a14j3ifhskngw0gfgn230g", "context": { "user_id": 9999999, "org_id": "edX", "course_id": "edX\/DemoX\/Demo_Course", "path": "\/change_enrollment", }, "ip": "NN.NN.NNN.NNN", "event": { "course_id": "edX\/DemoX\/Demo_Course", "user_id": 9999999, "mode": "honor" }, "event_type": "edx.course.enrollment.deactivated" } ============================================================================= ``edx.course.enrollment.mode_changed`` ============================================================================= The server emits an ``edx.course.enrollment.mode_changed`` event when the process of changing a student's ``student_courseenrollment.mode`` to a different mode is complete. **History**: Added 21 Aug 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The course in which the student's enrollment mode has changed. * - ``mode`` - string - 'audit', 'honor', 'professional', verified'. Identifies the student's new enrollment mode. * - ``user_id`` - number - Identifies the student whose enrollment mode changed. ============================================================================= ``edx.course.enrollment.upgrade.clicked`` ============================================================================= Students who enroll with a ``student_courseenrollment.mode`` of 'audit' in a course that has a verified certificate option see an upgrade link or button for the course in various locations. The browser emits this event when a student clicks this option, and the process of upgrading the ``student_courseenrollment.mode`` for the student to 'verified' begins. **History**: Added 18 Dec 2013; ``location`` field added 10 Oct 2017. **Event Source**: Browser ``context`` **Member Fields**: In addition to the :ref:`common` ``context`` member fields, this event type also includes the following ``context`` member field. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details and Member Fields * - ``location`` - string - The location in the LMS where the student clicked an upgrade link or button. * - ``mode`` - string - Enrollment mode when the user clicked an upgrade link or button: 'audit'. ``event`` **Member Fields**: None. .. _notes: ******************************** Notes Events ******************************** This section includes descriptions of the following events. * ``edx.course.student_notes.added`` * ``edx.course.student_notes.deleted`` * ``edx.course.student_notes.edited`` * ``edx.course.student_notes.notes_page_viewed`` * ``edx.course.student_notes.searched`` * ``edx.course.student_notes.used_unit_link`` * ``edx.course.student_notes.viewed`` The Notes tool allows learners to highlight and make notes about what they read in the body of the course. Learners can also add tags to their notes to make their notes easier to find. Learners can access their notes either in the body of the course or on a **Notes** page. .. _edx_course_student_notes_added: ===================================================== ``edx.course.student_notes.added`` ===================================================== The browser emits ``edx.course.student_notes.added`` events when a learner adds a note in the course. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``component_usage_id`` - string - The unique identifier for the Text component where the learner added the note. * - ``highlighted_content`` - string - The course text that the learner highlighted. The text is truncated at 8333 characters. * - ``note_id`` - string - The ID of the note. * - ``note_text`` - string - The text of the note. Notes are truncated at 8333 characters. * - ``tags`` - array of strings - An array of the tags that the learner has specified. The text is truncated at 8333 characters. If the text is truncated, only complete tag names appear in the array. If the learner did not specify tags, the array is empty. * - ``truncated`` - array of strings - Lists the names of any truncated fields. Values can be ``note_text``, ``highlighted_content``, and ``tags``. If no fields have been truncated, the array is empty. The ``truncated`` field can also include the values ``old_note_text`` or ``old_tags`` if the text in either of those fields is truncated. These fields are found in the :ref:`edx_course_student_notes_edited` event. ===================================================== ``edx.course.student_notes.deleted`` ===================================================== The browser emits ``edx.course.student_notes.deleted`` events when a learner deletes a note in course. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: The member fields in the ``edx.course.student_notes.deleted`` event are the same as the member fields in the :ref:`edx_course_student_notes_added` event. .. _edx_course_student_notes_edited: ===================================================== ``edx.course.student_notes.edited`` ===================================================== The browser emits ``edx.course.student_notes.edited`` events when a learner edits a note in course. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.course.student_notes.edited`` event includes the following fields in addition to the member fields in the :ref:`edx_course_student_notes_added` event. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``old_note_text`` - string - The text of the note before the learner edited it. Notes are truncated at 8333 characters. * - ``old_tags`` - array of strings - Content of the array of tags before the learner edited it. Text is truncated at 8333 characters. If the text is truncated, only complete tag names appear in the array. If the learner did not specify tags, the array is empty. ===================================================== ``edx.course.student_notes.notes_page_viewed`` ===================================================== The browser emits ``edx.course.student_notes.notes_page_viewed`` events when a learner accesses the **Notes** page or selects a different view on the page. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``view`` - string - The view on the **Notes** page that the learner selects. Possible values are ``Recent Activity`` and ``Search Results``. Because "Recent Activity" is the default view, the browser always emits an ``edx.course.student_notes.notes_page_viewed`` event that has a ``view`` field value of "Recent Activity" the first time that the learner accesses the page. ===================================================== ``edx.course.student_notes.searched`` ===================================================== The browser emits ``edx.course.student_notes.searched`` events when a learner searches notes on the **Notes** page. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``number_of_results`` - integer - The number of search results. * - ``search_string`` - string - The text of the search query. ===================================================== ``edx.course.student_notes.used_unit_link`` ===================================================== The browser emits ``edx.course.student_notes.used_unit_link`` events when a learner uses a note link on the **Notes** page to go to the Text component that contains that note. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``component_usage_id`` - string - The ID of the component where the learner added the note. * - ``note_id`` - string - The ID of the note. * - ``view`` - string - Identifies the **Notes** page view that the learner was using when the learner selected the note. Possible values are ``Recent Activity`` and ``Search Results``. ===================================================== ``edx.course.student_notes.viewed`` ===================================================== The browser emits ``edx.course.student_notes.viewed`` events when a learner views one or more notes on a page in the course. **History**: Added 16 March 2016. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``notes`` - array - A list of the ``note_id`` values for any currently visible notes. Learners can add multiple notes to the same text. Contains the member field ``note_id``, which contains the unique identifier for the note. .. _ora2: ************************************** Open Response Assessment Events ************************************** This section includes descriptions of the following events. .. contents:: :local: :depth: 1 In an open response assessment, learners review a question and then submit a text response and, optionally, an image, .pdf, or other file. To evaluate their own and one or more other learners' responses to the questions, learners use a scoring rubric designed by the course team. Course team members with staff privileges can also evaluate learners' responses, either in a staff assessment step included in the assignment, or by overriding an existing assignment score. **Component**: Open Response Assessments **History:** The open response assessment feature was released in August 2014; limited release of this feature began in April 2014. The ability for course team members to either include a staff assessment step in the assignment, or to perform a staff override grade, was added in January 2016. ===================================================== ``openassessmentblock.get_peer_submission`` ===================================================== After learners submit their own responses for evaluation, they use the scoring rubric to evaluate the responses of other course participants. The server emits this event when a response is delivered to a learner for evaluation. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``course_id`` - string - The identifier of the course that includes this assessment. * - ``item_id`` - string - The locator string that identifies the problem in the course. * - ``requesting_student_id`` - string - The course-specific anonymized user ID of the learner who retrieved the response for peer assessment. * - ``submission_returned_uuid`` - string - The unique identifier of the response that was retrieved for assessment. If no assessment is available, this is set to "None". ======================================================== ``openassessmentblock.get_submission_for_staff_grading`` ======================================================== If a staff assessment step exists in the open response assessment, a member of the course staff evaluates a learner's response using the same rubric that is used for self and peer assessments. When a course team member retrieves a learner's response for grading in the staff assessment step, the server emits an ``openassessmentblock.get_submission_for_staff_grading`` event. **History**: Added 20 Jan 2016. **Event Source**: Server ``event`` **Member Fields**: This event type includes the same ``context`` and ``event`` member fields as the ``openassessmentblock.get_peer_submission`` event and also includes the following ``event`` member fields. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``requesting_staff_id`` - string - The course-specific anonymized user ID of the course team member who is retrieved the response for grading. * - ``type`` - string - Indicates the type of staff grading that is being performed. Currently, the only valid value is "full-grade", which indicates that staff grading is being done in a staff assessment step. ===================================================== ``openassessmentblock.peer_assess`` ===================================================== The server emits this event when a learner submits an assessment of a peer's response. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``feedback`` - string - The learner's comments about the submitted response. * - ``parts: [criterion, option, feedback]`` - array - The ``parts`` field contains member fields for each ``criterion`` in the rubric, the ``option`` that the learner selected for it, and any ``feedback`` comments that the learner supplied. These member fields are repeated in an array to include all of the rubric's criteria. * ``criterion`` (object) contains ``points possible`` and ``name`` member fields. * ``option`` (string). * ``feedback`` (string). When the only criterion in the rubric is learner feedback, ``points possible`` is 0 and the ``option`` field is not included. * - ``rubric`` - object - This field contains the member field ``contenthash``, which identifies the rubric that the learner used to assess the response. * - ``scored_at`` - datetime - Timestamp for when the assessment was submitted. * - ``scorer_id`` - string - The course-specific anonymized user ID of the learner who submitted this assessment. * - ``score_type`` - string - Possible values are "PE" for a peer assessment, "SE" for a self assessment, or "ST" for a staff assessment. * - ``submission_uuid`` - string - The unique identifier for the submitted response. ===================================================== ``openassessmentblock.self_assess`` ===================================================== The server emits this event when a learner submits a self-assessment of their own response. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: This event type includes the same ``context`` and ``event`` member fields as the ``openassessmentblock.peer_assess`` event. ===================================================== ``openassessmentblock.staff_assess`` ===================================================== The server emits this event when a course team member submits an assessment of a learner's response. **History**: Added 20 January 2016. **Event Source**: Server ``event`` **Member Fields**: This event type includes the same ``context`` and ``event`` member fields as the ``openassessmentblock.peer_assess`` event. In addition, this event type includes this ``event`` member field. .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``type`` - string - Indicates the type of staff grading that is being performed. Possible values are "regrade" in the case of a grade override, or "full-grade" in the case of an included staff assessment step. ======================================================= ``openassessmentblock.submit_feedback_on_assessments`` ======================================================= The server emits this event when a learner submits a suggestion, opinion, or other feedback about the assessment process. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``feedback_text`` - string - The learner's comments about the assessment process. * - ``options`` - array - The label of each check box option that the learner selected to evaluate the assessment process. * - ``submission_uuid`` - string - The unique identifier of the feedback. ======================================================= ``openassessmentblock.create_submission`` ======================================================= The server emits this event when a learner submits a response. The same event is emitted when a learner submits a response for peer assessment or for self assessment. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``answer`` - object - This field contains a ``text`` (string) member field for the response. For responses that also include an image, .pdf, or other file, this field contains a ``file_upload_key`` (string) member field with the AWS S3 key that identifies the location of the uploaded file on the Amazon S3 storage service. This key is provided for reference only. * - ``attempt_number`` - number - This value is currently always set to 1. * - ``created_at`` - datetime - Timestamp for when the learner submitted the response. * - ``submitted_at`` - datetime - Timestamp for when the learner submitted the response. This value is currently always the same as ``created_at``. * - ``submission_uuid`` - string - The unique identifier of the response. ======================================================= ``openassessmentblock.save_submission`` ======================================================= The server emits this event when a learner saves a response. Learners can save responses before they submit them for assessment. **History**: Added 3 April 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``saved_response`` - object - This field contains a ``text`` (string) member field for the response. For responses that also include an image, .pdf, or other file, this field contains a ``file_upload_key`` (string) member field with the AWS S3 key that identifies the location of the uploaded file on the Amazon S3 storage service. This key is provided for reference only. ======================================================= ``openassessment.student_training_assess_example`` ======================================================= The server emits this event when a learner submits an assessment for an example response within a training step. To assess the example, the learner uses a scoring rubric provided by the course team. These events record the options that the learner selected to assess the example, and identify any criteria that the learner scored differently than the course team. **History**: Added 6 August 2014. **Event Source**: Server ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``corrections`` - object - A set of name/value pairs that identify criteria for which the learner selected a different option than the course team, in the format ``criterion_name: course-team-defined_option_name``. * - ``options_selected`` - object - A set of name/value pairs that identify the option that the learner selected for each criterion in the rubric, in the format ``'criterion_name': 'option_name'``. * - ``submission_uuid`` - string - The unique identifier of the response. Identifies the learner who is undergoing training. ======================================================= ``openassessment.upload_file`` ======================================================= The browser emits this event when a learner successfully uploads an image, .pdf, or other file as part of a response. Learners complete the upload process before they submit the response. **History**: Added 6 August 2014. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``fileName`` - string - The name of the uploaded file, as stored on the learner's client machine. * - ``fileSize`` - number - The size of the uploaded file in bytes. Reported by the learner's browser. * - ``fileType`` - string - The MIME type of the uploaded file. Reported by the learner's browser. ======================================================= ``openassessment.upload_file_error`` ======================================================= The browser emits this event when a learner encounters an error while uploading an image, .pdf, or other file as part of a response. This will block response submission until resolved. **History**: Added 14 December 2020. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``statusText`` - string - The error message returned from the failed upload. .. _pre-roll: ********************************** Pre-Roll Video Interaction Events ********************************** Course teams can create a short video message and configure it to play automatically before the videos in a course. * The pre-roll video plays on an infrequent schedule of once per user per week. * Only courses that run on the edx.org website can include a pre-roll video. * The edX mobile applications do not play pre-roll videos. When a user interacts with the pre-roll video, different events are emitted than for the other videos in the course. This section presents the pre-roll video events alphabetically. **History**: Added 10 Jun 2015. **Component**: Video =============================== ``edx.video.bumper.dismissed`` =============================== A browser emits this event when a user selects **Do not show again** for a pre-roll video. This option allows the user to opt out of viewing the course pre-roll video in the future. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.dismissed`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime`` * ``duration`` * ``host_component_id`` =============================== ``edx.video.bumper.loaded`` =============================== When the pre-roll video is fully rendered and ready to play, the browser emits an ``edx.video.bumper.loaded`` event. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.loaded`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``duration`` * ``host_component_id`` .. _edx.video.bumper.played: =============================== ``edx.video.bumper.played`` =============================== When a user selects the **play** control in the video player for a pre-roll video, the browser emits an ``edx.video.bumper.played`` event. **Event Source**: Browser ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``bumper_id`` - string - The escaped URL identifying the location of the pre-roll video that played. * - ``code`` - string - Contains the value 'html5'. All pre-roll videos are non-YouTube videos. * - ``currentTime`` - number - The time in the file at which the video played. * - ``duration`` - number - The length of the video file, in seconds. * - ``host_component_id`` - string - Identifier for the video component that the user selected, and that is queued to play after the pre-roll video. ============================================================== Example: ``edx.video.bumper.played`` Event ============================================================== .. code-block:: json { "username": "honor", "event_source": "browser", "name": "edx.video.bumper.played", "accept_language": "en-US,en;q=0.5", "time": "2015-05-26T18:22:07.684172+00:00", "agent": "Mozilla\/5.0 (X11; Ubuntu; Linux x86_64; rv:37.0) Gecko\/20100101 Firefox\/37.0", "page": "http:\/\/edx.org\/courses\/edX\/DemoX.1\/2015\/courseware\/0af8db2309474971bfa70cda98668a30\/ec3364075f2845baa625bfecd5970410\/", "host": "precise64", "session": "feae6efa342b309e776d388b16da89a6", "referer": "http:\/\/localhost:8001\/container\/i4x:\/\/edX\/DemoX\/vertical\/69dedd38233a46fc89e4d7b5e8da1bf4?action=new", "context": { "user_id": 7911, "org_id": "edX", "course_id": "edX\/DemoX.1\/2015", "path": "\/event" }, "ip": "123.0.0.1", "event": "{\"duration\": 10, \"bumper_id\": \"http:\/\/www.w3schools.com\/html\/mov_bbb.webm\", \"code\": \"html5\", \"currentTime\": 0, \"host_component_id\": \"i4x-edX-DemoX_1-video-4e2eeecf597040e3b5e1a27600bc8ddc\"}", "event_type": "edx.video.bumper.played" } =============================== ``edx.video.bumper.skipped`` =============================== A browser emits this event when a user selects **Skip** for a bumper video. This option allows the user to advance past the pre-roll video and begin to play the selected video immediately. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.skipped`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the pre-roll video was skipped. * ``duration`` * ``host_component_id`` =============================== ``edx.video.bumper.stopped`` =============================== A browser emits this event when the video player reaches the end of the pre- roll video file and play automatically stops. This is the only event that is emitted when a user pauses a pre-roll video. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.stopped`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the pre-roll video was stopped. * ``duration`` * ``host_component_id`` ============================================================== ``edx.video.bumper.transcript.hidden`` ============================================================== When a user selects **CC** to suppress display of the transcript for a pre-roll video, the browser emits a ``edx.video.bumper.transcript.hidden`` event. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.transcript.hidden`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the transcript was hidden. * ``duration`` * ``host_component_id`` ============================================================== ``edx.video.bumper.transcript.menu.hidden`` ============================================================== When a user selects a language from the **CC** menu for a pre-roll video that has transcripts in multiple languages, the browser emits an ``edx.video.bumper.transcript.menu.hidden`` event. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.transcript.menu.hidden`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the language was selected and the transcript menu was hidden. * ``duration`` * ``host_component_id`` ============================================================== ``edx.video.bumper.transcript.menu.shown`` ============================================================== When a user selects **CC** for a pre-roll video that has transcripts in multiple languages, the browser emits an ``edx.video.bumper.transcript.menu.shown`` event. This event is emitted in addition to the ``edx.video.bumper.transcript.shown`` event. **Event Source**: Browser ``event`` **Member Fields**: The ``edx.video.bumper.transcript.menu.shown`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the transcript menu was shown. * ``duration`` * ``host_component_id`` ============================================================== ``edx.video.bumper.transcript.shown`` ============================================================== When a user selects **CC** to display the transcript for a pre-roll video, the browser emits a ``edx.video.bumper.transcript.shown`` event. If the video has more than one transcript file, the ``edx.video.bumper.transcript.menu.shown`` event is also emitted. The ``edx.video.bumper.transcript.shown`` events include the following ``event`` member fields. These fields serve the same purpose for events of this type as for the :ref:`edx.video.bumper.played` events. * ``bumper_id`` * ``code`` * ``currentTime``: The point in the file at which the transcript was shown. * ``duration`` * ``host_component_id`` .. _problem: ******************************* Problem Interaction Events ******************************* This section includes descriptions of the following events. .. contents:: :local: :depth: 1 Problem interaction events are emitted by the server or the browser to capture information about interactions with core problem types. These events were designed for the problem types implemented in the edX platform by the ``capa_module.py`` XBlock. Problem types that are implemented by other XBlocks, such as :ref:`open response assessments`, or :ref:`drag and drop problems`, are instrumented with different events. =============================================== ``edx.problem.hint.demandhint_displayed`` =============================================== Course teams can design problems to include one or more hints. For problems that include hints, the server emits an ``edx.problem.hint.demandhint_displayed`` event each time a user requests a hint. **History**: Added on 1 Jul 2015. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``hint_index`` - number - Identifier for the hint that was displayed to the user. The first hint defined for a problem is identified with ``hint_index: 0``. * - ``hint_len`` - number - The total number of hints defined for this problem. * - ``hint_text`` - string - The text of the hint that was displayed to the user. * - ``module_id`` - string - Identifier for the problem component for which the user requested the hint. =============================================== ``edx.problem.hint.feedback_displayed`` =============================================== Course teams can design problems to include feedback messages that appear after a user submits an answer. For problems that include feedback messages, the server emits an ``edx.problem.hint.feedback_displayed`` event each time a user selects **Submit**. **History**: Added on 1 Jul 2015. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``choice_all`` - array - For problems that have a set of possible answers defined, such as checkbox problems, lists all of the answer choices. * - ``correctness`` - Boolean - 'True' if the ``student_answer`` response is correct. 'False' if the ``student_answer`` is incorrect. * - ``hint_label`` - string - The optional label, such as 'Correct: ' or 'Incorrect: ', provided for the feedback message. * - ``hints`` - array - Contains a ``text`` member field with the feedback string that was displayed to the user. For some problem types, such as checkbox problems, feedback can be provided for more than one answer at a time, including both correct and incorrect answers. A separate ``text`` member field is included for each feedback message that was displayed. * - ``module_id`` - string - Identifier for the problem component for which the user received the feedback. * - ``problem_part_id`` - string - For problem components that contain more than one problem, identifies the specific problem for which the user received feedback. * - ``question_type`` - string - The XML element that identifies the problem type. For example, 'stringresponse' for a text input problem. * - ``student_answer`` - array - The answer value selected or supplied by the user. For problem types that accept multiple answers, such as checkbox problems, every response, including both selected and unselected options, is included. * - ``trigger_type`` - string - Identifies the type of feedback elicited by the ``student_answer`` response. For checkbox problems only, course teams can design 'compound' feedback that is provided when a user's response matches an exact set of correct and incorrect selections across all of the available choices. All other types of feedback are identified as 'single'. ================= ``problem_check`` ================= The server emits ``problem_check`` events when a problem is successfully checked. Both browser interactions and server requests produce ``problem_check`` events, so your data package can also contain events with an event source of browser. Events emitted by the browser contain all of the GET parameters. Only events emitted by the server are useful for most purposes. **History**: * On 7 Sep 2016, added the ``submission.group_label`` member field. * On 5 Mar 2014, the ``submission`` object was added to the ``event`` field and ``module`` was added to the ``context`` field. * Prior to 15 Oct 2013, this server-emitted event was named ``save_problem_check``. * Prior to 15 Jul 2013, this event was emitted twice for the same action. **Event Source**: Server ``context`` **Member Fields**: This event type includes the :ref:`common` ``context.module`` member field. ``event`` **Member Fields**: .. list-table:: :widths: 15 15 60 :header-rows: 1 * - Field - Type - Details * - ``answers`` - object - The problem ID and the internal answer identifier in a name/value pair. For a component with multiple problems, lists every problem and answer. * - ``attempts`` - number - The number of times the user attempted to answer the problem. * - ``correct_map`` - object - For each problem ID value listed by ``answers``, provides: * ``correctness``: string; 'correct', 'incorrect' * ``hint``: string; Gives optional hint. Nulls allowed. * ``hintmode``: string; None, 'on_request', 'always'. Nulls allowed. * ``msg``: string; Gives extra message response. * ``npoints``: number; Points awarded for this ``answer_id``. Nulls allowed. * ``queuestate``: object; None when not queued, else ``{key:'', time:''}`` where ``key`` is a secret string dump of a DateTime object in the form '%Y%m%d%H%M%S'. Nulls allowed. * - ``grade`` - number - Current grade value. * - ``max_grade`` - number - Maximum possible grade value. * - ``problem_id`` - string - ID of the problem that was checked. * - ``state`` - object - Current problem state. * - ``submission`` - object - Provides data about the response made. For problem components that include multiple questions, a separate ``submission`` object is provided for each one. * ``answer``: string; The value that the student entered, or the display name of the value selected. * ``correct``: Boolean; 'true', 'false'. * ``group_label``: string; Present only for questions that have multiple input types, such as a multiple choice problem that includes a text input field for learners to provide a rationale for their choice, within the response type. Presents the question or prompt from the ``