Sessions Detail by Item Report

Shows the learner's responses to each Item for a single session.

You would want to use this report to have an experience like viewing the learner's scored exam paper, with details of how each Question was scored.

Question responses are rendered in review mode, which is read-only and shows the attempted and correct responses. Each Item is presented in full, including any static content and Features embedded in the Item container.

The report also shows a badge indicating the learner's score for each Item, according to the scoring rule configured on the Item during authoring. See Item scoring for details.

Important This report only works for sessions created with Items API. For Assess API or Questions API sessions, use Sessions Detail by Question report.

Note Intro and outro items are not included in this report.

Examples

// Example report configuration
{
    "id":                   "report-demo",
    "type":                 "session-detail-by-item",
    "user_id":              "$ANONYMIZED_USER_ID",
    "session_id":           "8c393c87-77b6-4c14-8da7-75d39243e642",
    "questions_api_init_options": {
        "showCorrectAnswers": false
    }
}

Attributes

• type string

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

• 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: true

• items_api_init_options object

  Initialization options to be passed through to Items API.

  The following options are supported:

  • config.ignore_question_attributes
  • retrieve_tags

• items_order array[string]

  An array of Item references to order the Items presented in the report.

  Note Any Items which are not listed in the array will not appear in the report. If there are Items which are in the array, but are not in the report, then this will return an error.

• questions_api_init_options object

  Initialization options to be passed through to Questions API.

  The following options are supported:

  • labelBundle
  • math_renderer
  • question_source
  • render_with_captured_questions
  • show_distractor_rationale
  • showCorrectAnswers
  • showInstructorStimulus

• 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