Learning-Outcomes-Report - Report-types - Reports API

Learning Outcomes Report

This is a premium feature and may not be included in your product license. For more information, reach out to your Learnosity Account Manager.

Shows a drill-down report where you can explore the results for learners, broken down by Tags (by subject, for instance).

You would want to use this to review the overall year's performance for a single learner, class, or cohort, for example.

This report can show granular results by any taggable attribute of your content such as: topic area, learning outcome, content type, difficulty, and depth of knowledge. It can also show results for intersections of those attributes, for example, scores for word-based algebraic math Questions at a beginner level.

The report uses a concept of live datasets to provide real-time score data as learner sessions are submitted.

Important This report is a premium bundle add-on. To get started using this report type, contact Learnosity Support about the Tag types you would like to use for your drill-down behavior.

Note

  • This report does not currently support multiple Item banks and is not currently integrated with any partner Item banks.
  • This report is also known as the "item-scores-by-tag-by-user" report.

See Introduction to Learning Outcomes Reporting for more information.

Related articles

Examples

// Example report configuration
{
    "reports": [
        {
            "id": "item-scores-by-tag-by-user-report",
            "type": "item-scores-by-tag-by-user",
            "items_tags_live_dataset_reference": "content-hierarchy-items-dataset-00001",
            "session_items_live_dataset_reference": "content-hierarchy-sessions-dataset-00001",
            "users": [
                {
                    "id": "user_20180417a_00001",
                    "name": "Milhouse Vanhouten"
                },
                {
                    "id": "user_20180417a_00002",
                    "name": "Bart Simpson"
                },
                {
                    "id": "user_20180417a_00003",
                    "name": "Sherri Mackleberry"
                }
            ],
            "row_tag_type": "ch_proficiency_strand",
            "column_tag_types": [
                "ch_topic",
                "ch_subtopic",
                "ch_curriculum_code"
            ],
            "item_tags": [
                {
                    "type": "ch_title",
                    "name": "content_hierarchy_001"
                }
            ]
        }
    ],
    "label_bundle": {
        "total": "Practical Math, 2nd Ed."
    }
}

Attributes

  • type string

    The type of this report. Must be "item-scores-by-tag-by-user".

  • id string

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

  • items_tags_live_dataset_reference string

    Reference to an item tags live dataset. Please contact us to set up a live dataset that meets your needs.

  • session_items_live_dataset_reference string

    Reference to an session items live dataset. Please contact us to set up a live dataset that meets your needs.

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

    The following properties are supported.

    • id string

      The ID of the user (learner).

    • name string

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

  • row_tag_type string

    A tag type to use for pivoting data into rows per user. If omitted, the report will not display scores by tags rows, but instead show the scores on the student level.

  • column_tag_type array[string]

    Array of string tag types indicating the hierarchy of the column data. Each tag type add a level to the report.

  • session_statuses array[string]

    Array containing strings of sessions_statuses to include.

  • session_tags array[object]

    An array of tags limiting the data of the report to sessions that include the specified tags.

    The following properties are supported.

    • type string

      The type of the tag.

    • name string

      The name of the tag.

  • item_tags array[object]

    An array of tags limiting the data of the report to items that include the specified tags.

    The following properties are supported.

    • type string

      The type of the tag.

    • name string

      The name of the tag.

  • activity_ids array[string]

    A set of activity IDs for optional filtering.

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

  • min_time_started int | string

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

    Default: false

  • max_time_started int | string

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

    Default: false

  • 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

  • tag_labels string

    Choose whether to use the Tag "name" or "description" for the labels shown in the report.

    When using "description" and a Tag does not have a description value, the Tag's name will be used instead.

    Default: "description"

    Possible values

    • "description"
    • "name"
Was this article helpful?

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