Sessions-Detail-by-Question-Report - Report-types - Reports API

Sessions Detail by Question Report

Shows the specific responses of the learner for each Question for a single session.

You would want to use this report to view one Question at a time with details of how each Question was answered without any accompanying reference material.

Question responses are rendered in review mode, which is read-only and shows the attempted and correct responses. This report only displays the specific Questions embedded in each Item; any additional content and Features from the Item container will be omitted.

Examples

// Example report configuration
{
    "id":                   "report-demo",
    "type":                 "session-detail-by-question",
    "user_id":              "$ANONYMIZED_USER_ID",
    "session_id":           "B146BA2C-C2D0-4368-B90FFBA2B245F2BA",
    "questions_api_init_options": {
        "showCorrectAnswers": false
    }
}

Attributes

  • type string

    The type of this report. Must be "session-detail-by-question".

  • id string

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

  • user_id string

    The ID of the user (learner) to report on.

  • session_id string

    The ID of the session to report on.

  • display_scores boolean

    Show the Item scores next to each Item in the report.

    Default: false

  • load_content_from_source boolean

    Determines which version of the Question content to load.

    By default, the report will always retrieve the version of the Question served at the time of the learner's session.

    When set to true, the report will render the Question using the latest version stored in the Item pool from which the assessment was served (or from the Item bank if no Item pool was used).

    Note Setting this value to true only works for sessions created with Items API.

    Default: false

  • questions_api_init_options object

    Initialization options to be passed through to Questions API.

    The following options are supported:

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