Sessions-List-by-Item-Report - Report-types - Reports API

Sessions List by Item Report

Shows the performance of Items across multiple sessions. The report indicates which Items were correct, incorrect, unattempted, and partially correct in each session.

You would want to use this to find out if any particular Item caused a large group of learners not to fail or not attempt an Item, for example.

For a group of users, lists up to 100 sessions against an Activity and the per-Item score on each session.

Scoring details

Hovering over Item nodes in the report shows the learner's score for the Item, according to the scoring rule configured on the Item during authoring. Note that Items may have different maximum scores, and therefore contribute a different weighting to the overall score.

Examples

// Example report configuration
{
    "reports": [
        {
            "id":    "sessions-list-by-item",
            "type":  "sessions-list-by-item",
            "limit": 50,
            "display_user": true,
            "activity_id": "Weekly_Math_Quiz",
            "users": [
                {"id": "mce_student", "name": "Brian Moser"}
            ]
        }
    ]
}

// Example response data
{
    "data": {
        "sessions": [
            {
                "session_id": "d7ad7585-a0c1-4c01-9762-44a85f55835c",
                "time_completed": "2019-04-09 05:37:51",
                "user_id": "mce_student",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8",
                "items": [
                    {
                        "score": 0,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": null,
                        "max_score": 2,
                        "type": "per-question",
                        "max_score_of_attempted": 0,
                        "max_score_of_unmarked": 0,
                        "attempted": false,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 0,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 4,
                        "type": "per-question",
                        "max_score_of_attempted": 4,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 1,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    },
                    {
                        "score": 0,
                        "max_score": 1,
                        "type": "per-question",
                        "max_score_of_attempted": 1,
                        "max_score_of_unmarked": 0,
                        "attempted": true,
                        "unmarked": false
                    }
                ]
            },
            {
                "session_id": "0df4a070-78dc-4b51-a41d-102911f9521a",
                "time_completed": "2016-12-12 05:37:06",
                "user_id": "mce_student",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8",
                "items": []
            },
            {
                "session_id": "b4a46a9c-2c89-405f-ab54-d41f4319d9c8",
                "time_completed": "2016-01-29 03:12:56",
                "user_id": "mce_student",
                "activity_id": "Weekly_Math_Quiz",
                "exam_name": "Summer Test: Math - Grade 8",
                "items": []
            }
        ]
    },
    "meta": {
        "status": true
    },
    "id": "sessions-list-by-item"
}

Attributes

  • type string

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

  • activity_id string

    The ID of the Activity to report on.

  • id string

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

  • users array[object]

    An array of user (learner) 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 (learner).

    • name string

      The name of the user (learner) for display purposes.

  • align_items string

    Specifies which Items are returned for each session and how they are ordered in the report UI and raw data.

    Default: "reference"

    Possible values

    • "reference" The Item nodes are ordered left-to-right according to the order of Items in the most recent retrieved session. If an earlier session did not include one or more of those Items, that session's raw data will contain null entries for the missing Items, and those Item nodes will not be displayed in the UI. Use this mode where each session is expected to contain the same Items (in a potentially variable order).
    • "index" The Item nodes are ordered left-to-right according to the order they appeared in each session. The full list of Items for each session is returned in their original order. If one or more sessions contain a different number of Items, the report UI will expand to accommodate all Items in the largest session. Shorter sessions will be padded with blank nodes in the UI. Use this mode where each session may contain different Items. You can use the default UI to compare the sessions based on the order the Items were presented, or access the raw data to compare the sessions in a different way.
  • 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.

    Version added: v2023.1.LTS

  • 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.

    Version added: v2023.1.LTS

  • 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

Was this article helpful?

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