Sessions-List-Report - Report-types - Reports API

Sessions List Report

Shows a list of sessions against Activities and user (learner) scores as a percentage per session, for a group of users.

You would want to use this to identify common pattern across multiple sessions or Activities. For example, comparing a class of learners' scores against each other for a particular exam or comparing a singular learner's scores across a period of time.

The list is sorted in descending order based on time submitted.

Scoring details

The report uses partial Item scoring, so the overall score is the sum of the individual Item scores (including any partially correct Items) as a percentage of the maximum possible score for all Items.

Examples

// Example report configuration
{
    "reports": [
        {
            "id": "report-10",
            "type": "sessions-list",
            "limit": 5,
            "ui": "table",
            "ui_clickable": {
                "session":false
            },
            "users": [
                {"id": "mce_student_3", "name": "Student 1"},
                {"id": "mce_student_2", "name": "Student 2"},
                {"id": "mce_student_1", "name": "Student 3"},
                {"id": "mce_student", "name": "Student 4"}
            ],
            "activities": [
                {"id": "Weekly_Math_Quiz", "name": "Weekly Math Quiz"}
            ],
            "render": true,
            "display_user": true,
            "display_activity": true
        }
    ]
}

// Example data
{
    "data": {
        "sessions": [
            {
                "session_id": "ab040715-ba02-485d-95a7-b1cb5100a898",
                "max_score": "15.00",
                "score": "0.00",
                "max_score_of_attempted": "2.00",
                "max_score_of_unmarked": "0.00",
                "time_completed": "2019-04-09 05:37:58",
                "user_id": "mce_student_2",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8"
            },
            {
                "session_id": "d7ad7585-a0c1-4c01-9762-44a85f55835c",
                "max_score": "16.00",
                "score": "8.00",
                "max_score_of_attempted": "14.00",
                "max_score_of_unmarked": "0.00",
                "time_completed": "2019-04-09 05:37:51",
                "user_id": "mce_student",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8"
            },
            {
                "session_id": "ce18b5f3-64bb-4df8-9296-964d28bc4524",
                "max_score": "15.00",
                "score": "12.00",
                "max_score_of_attempted": "15.00",
                "max_score_of_unmarked": "0.00",
                "time_completed": "2019-04-09 05:37:51",
                "user_id": "mce_student_1",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8"
            },
            {
                "session_id": "797ebfb9-2280-412f-8c07-ae1f4fef7389",
                "max_score": "15.00",
                "score": "12.00",
                "max_score_of_attempted": "12.00",
                "max_score_of_unmarked": "0.00",
                "time_completed": "2019-04-09 05:37:50",
                "user_id": "mce_student_3",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8"
            },
            {
                "session_id": "b09efac7-2de0-46fa-921b-a1cc16cbe8e2",
                "max_score": "15.00",
                "score": "0.00",
                "max_score_of_attempted": "2.00",
                "max_score_of_unmarked": "0.00",
                "time_completed": "2019-04-09 05:37:49",
                "user_id": "mce_student_2",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8"
            }
        ]
    },
    "meta": {
        "status": true
    },
    "id": "report-10"
}

Attributes

  • type string

    The type of this report. Must be "sessions-list".

  • id string

    The HTML element ID where you want this report to appear.

  • activities array[object]

    An array of Activites to include in the report.

    Note If you need more than 100 Activities, contact Learnosity Support.

    The individual Activity definitions include the following properties.

    • id string

      The ID of the Activity.

    • name string

      The name of the Activity to show in the report. If not provided, this defaults to the name specified during session initialization.

      Default: The name specified with Items API when the assessment session was initialized.

  • display_activity boolean

    Controls whether the Activity name is shown.

    Default: true

  • display_user boolean

    Controls whether the learner name(s) is shown in the report.

    Default: false

  • limit number

    The number of sessions to show.

    Default: 10

  • maxtime number string

    A timestamp filter based on the completion time of the sessions. The latest UTC Unix timestamp or datetime string (in ISO 8601 format) to get results from.

  • mintime number string

    A timestamp filter based on the completion time of the sessions. The earliest UTC Unix timestamp or datetime string (in ISO 8601 format) to get results from.

  • render boolean

    Renders the report on your page at the location set with the specified HTML element ID.

    You would set this property to false if you wanted to receive the raw report data only and use your own custom UI to display it.

    Default: true

  • ui string

    The user interface style for this report.

    Default: "table"

    Possible values

    • "table"
    • "list"
  • ui_clickable object

    Controls the styling for clickable elements.

    If you listen for a click event for this report using the on() method, the corresponding attribute below will be true by default:

    • session boolean

      Clickable style for sessions in the list.

  • users array[object]

    An array of user definitions to include in the report.

    Note If you need more than 100 users, contact Learnosity Support.

    The individual user definitions include the following properties.

    • id string

      The ID of the user.

    • name string

      The name of the user for display purposes.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.