Report Types

Example - Sessions List

{
    "id": "report-10",
    "type": "sessions-list",
    "limit": 5,
    "ui": "table",
    "activities": [
        {"id": "Summer_Test_1", "name": "Summer Test 1, 2015"},
        {"id": "Weekly_Math_Quiz", "name": "Weekly Math Quiz"}
    ]
}

Attributes - Sessions List

id

type

ui

ui_clickable

Toggle clickable styling for certain elements.

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

limit

mintime

maxtime

users

An array of one or more user objects:

activities

An array of one or more activity objects:

render

display_user

display_activity

Example - Sessions List By Item

{
    "id":    "sessions-list-by-item-1",
    "type":  "sessions-list-by-item",
    "limit": 5,
    "display_user": true,
    "activity_id": "edde56e8-ff65-e42e-b4fe49caad796bd",
    "users": [
        {"id": "brianmoser", "name": "Brian Moser"},
        {"id": "12345678", "name": "John Carter"}
    ]
}

Attributes - Sessions List By Item

id

type

limit

mintime

maxtime

activity_id

users

An array of one or more user objects:

display_user

align_items

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

It may be set to one of the following strings:

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

render

Example - Sessions Summary

{
    "id":          "report-demo",
    "type":        "sessions-summary",
    "user_id":     "brianmoser",
    "session_ids": [
        "AC023456-2C73-44DC-82DA28894FCBC3BF"
    ]
}

Attributes - Sessions Summary

id

type

user_id

session_ids

render

Example - Sessions Summary by Question

{
    "id": "report-24",
    "type": "sessions-summary-by-question",
    "user_id": "mce_student",
    "session_ids": [
        "d7ad7585-a0c1-4c01-9762-44a85f55835c"
    ]
}

Attributes - Sessions Summary by Question

id

type

user_id

session_ids

render

Example - Sessions Summary by Tag

{
    "id":                  "demo-bar-chart",
    "type":                "sessions-summary-by-tag",
    "scoring_type":        "partial",
    "user_id":             "brianmoser",
    "ui":                  "bar-chart",
    "hierarchy_reference": "author",
    "session_ids":         ["B146BA2C-C2D0-4368-B90FFBA2B245F2BA"]
}

Attributes - Sessions Summary by Tag

id

type

ui

• table
• bar-chart Deprecated

scoring_type

user_id

session_ids

hierarchy_reference

tag_labels

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarcies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

render

Example - Session Detail By Item

{
    "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 - Session Detail By Item

id

type

user_id

session_id

items_api_init_options

questions_api_init_options

render

display_scores

Example - Session Detail By Question

{
    "id":                   "report-demo",
    "type":                 "session-detail-by-question",
    "user_id":              "brianmoser",
    "session_id":           "B146BA2C-C2D0-4368-B90FFBA2B245F2BA",
    "questions_api_init_options": {
        "showCorrectAnswers": false
    }
}

Attributes - Session Detail By Question

id

type

user_id

session_id

questions_api_init_options

display_scores

render

load_content_from_source

Example - Progress by Tag

{
    "id": "report-3",
    "type": "progress-by-tag",
    "user_id": "mce_student_1",
    "hierarchy_reference": "CCSS"
}

Attributes - Progress by Tag

id

type

ui

user_id

hierarchy_reference

tag_labels

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarchies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

render

Example - Progress by Tag By User

{
    "id":"report-9",
    "type":"progress-by-tag-by-user",
    "users":[{"id":"mce_student_1","name":"Brian Moser"},{"id":"mce_student_2","name":"John Carter"}],
    "hierarchy_reference":"CCSS"
}

Attributes - Progress by Tag By User

id

type

ui_clickable

Toggle clickable styling for certain elements.

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

users

An array of one or more user objects:

hierarchy_reference

tag_hierarchy_path

An array of tags describing the path through the hierarchy, starting at the top level moving down to the tag you want to report progress on.

By default, the report will be based on the top level of the hierarchy.

tag_labels

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarcies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

render

Example - Event Progress by Tag by User

{
    "id": "event-progress-1",
    "type": "event-progress-by-tag-by-user",
    "users": [
        { "id": "brianmoser", "name": "Brian Moser" },
        { "id": "12345678", "name": "John Carter" }
    ],
    "event": {
        "id": "correct_with_help",
        "display": "Correct with Help"
    },
    "hierarchy_reference": "questiontype",
    "tag_hierarchy_path": [
        {
            "type": "questiontype",
            "name": "clozeassociation"
        }
    ]
}

Attributes - Event Progress by Tag by User

id

type

ui_clickable

Toggle clickable styling for certain elements.

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

users

An array of one or more user objects:

event

An object that describes the event to show progress on.

hierarchy_reference

tag_hierarchy_path

An array of tags describing the path through the hierarchy, starting at the top level moving down to the tag you want to report progress on.

By default, the report will be based on the top level of the hierarchy.

tag_labels

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarcies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

render

Example - Progress - Single

{
    "id":                  "progress-bar-1",
    "type":                "progress-single",
    "ui":                  "bar",
    "user_id":             "12345678",
    "hierarchy_reference": "book",
    "tag_hierarchy_path":  [
        {
            "type": "course",
            "name": "maths"
        },
        {
            "type": "chapter",
            "name": "4 - Probability"
        }
    ]
}

Attributes - Progress - Single

id

type

ui

user_id

hierarchy_reference

tag_hierarchy_path

An array of tags describing the path through the hierarchy, starting at the top level moving down to the tag you want to report progress on.

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarcies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

render

Example - Last Score by Activity by User

{
    "id": "report-5",
    "type": "lastscore-by-activity-by-user",
    "scoring_type": "partial",
    "ui": "numeric",
    "display_time_spent": true,
    "users": [
        {"id": "mce_student", "name": "Jesse Pinkman"},
        {"id": "mce_student_1", "name": "Walter White"},
        {"id": "mce_student_2", "name": "Skylar White"},
        {"id": "mce_student_3", "name": "Saul Goodman"}
    ],
    "activities": [
        {"id": "Summer_Test_1", "name": "Summer Test"},
        {"id": "Weekly_Math_Quiz", "name": "Weekly Math Quiz"}
    ]
}

Attributes - Last Score by Activity by User

id

type

ui

ui_clickable

Toggle clickable styling for certain elements.

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

scoring_type

users

An array of one or more user objects:

activities

An array of one or more activity objects:

display_time_spent

If display_time_spent is set to true, the time spent on each activity is shown in the tooltips for each activity score. Time spent is categorized by correct, incorrect, unattempted, unmarked and total items.

Note: time spent is always calculated dichotomously for the items in each activity, regardless of what scoring_type is set for this report. Time spent for partially unmarked items will be reported as unmarked; for fully marked items, time spent on partially attempted and partially correct items will be reported as incorrect. This means a report in partial scoring mode may show a non-zero correct score, but no time spent on correct items.

render

Example - Last Score by Activity

{
    "id": "report-6",
    "type": "lastscore-by-activity",
    "scoring_type": "partial",
    "user_id": "mce_student",
    "display_time_spent": true,
    "activities": [
        {"id": "Summer_Test_1", "name": "Summer Test"},
        {"id": "Weekly_Math_Quiz", "name": "Weekly Math Quiz"}
    ]
}

Attributes - Last Score by Activity

id

type

user_id

ui

ui_clickable

Toggle clickable styling for certain elements.

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

scoring_type

activities

An array of one or more activity objects:

display_time_spent

If display_time_spent is set to true, the time spent on each activity is shown in the tooltips for each activity score. Time spent is categorized by correct, incorrect, unattempted, unmarked and total items.

Note: time spent is always calculated dichotomously for the items in each activity, regardless of what scoring_type is set for this report. Time spent for partially unmarked items will be reported as unmarked; for fully marked items, time spent on partially attempted and partially correct items will be reported as incorrect. This means a report in partial scoring mode may show a non-zero correct score, but no time spent on correct items.

render

Example - Last Score by Item by User

{
    "id": "report-7",
    "type": "lastscore-by-item-by-user",
    "display_time_spent": true,
    "display_item_numbers": true,
    "scoring_type": "partial",
    "users": [
        {"id": "mce_student", "name": "Jesse Pinkman"},
        {"id": "mce_student_2", "name": "Skylar White"},
        {"id": "mce_student_1", "name": "Walter White"},
        {"id": "mce_student_3", "name": "Saul Goodman"}
    ],
    "activity_id": "Weekly_Math_Quiz"
}

Attributes - Last Score by Item by User

id

type

display_item_numbers

display_time_spent

If display_time_spent is set to true, the time spent on each item is shown in the tooltip that is activated by hovering over the item score icon.

ui_clickable

Toggle clickable styling for certain elements.

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

scoring_type

users

An array of one or more user objects:

activity_id

render

align_items

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

It may be set to one of the following strings:

• "reference": The item nodes are ordered left-to-right according to the order of items in the session of the first specified user. If another user's session did not include one or more of those items, that session's raw data will not contain 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.

Example - Last Score by Tag by User

{
    "id": "report-8",
    "type": "lastscore-by-tag-by-user",
    "display_time_spent": true,
    "users": [
        {"id": "mce_student", "name": "Jesse Pinkman"},
        {"id": "mce_student_1", "name": "Walter White"},
        {"id": "mce_student_2", "name": "Skylar White"},
        {"id": "mce_student_3", "name": "Saul Goodman"}
    ],
    "activity_id": "Weekly_Math_Quiz",
    "hierarchy_reference": "DepthofKnowledge"
}

Attributes - Last Score by Tag by User

id

type

scoring_type

users

An array of one or more user objects:

activity_id

hierarchy_reference

tag_labels

organisation_id

The ID of the Item bank to fetch Item data and Tag content and Hierarcies from. This needs to match the organisation_id used when initialising the Sessions.

The consumer making the request will need to have access to the Item bank. This access can be ensured via API consumers configuration in the Learnosity Console.

ui_clickable

Toggle clickable styling for certain elements.

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

display_time_spent

If display_time_spent is set to true, the time spent on each activity and tag is shown in the tooltips for each activity and tag score. Time spent is categorized by correct, incorrect, unattempted, unmarked and total items.

Note: time spent is always calculated dichotomously for the items in each activity, regardless of what scoring_type is set for this report. Time spent for partially unmarked items will be reported as unmarked; for fully marked items, time spent on partially attempted and partially correct items will be reported as incorrect. This means a report in partial scoring mode may show a non-zero correct score, but no time spent on correct items.

render

Example - Last Score - Single

{
    "id":          "lastscore-bar-1",
    "type":        "lastscore-single",
    "ui":          "bar",
    "user_id":     "12345678",
    "activity_id": "mid-term"
}

Attributes - Last Score - Single

id

type

ui

user_id

activity_id

render

Example - Live Activity Status by User

{
    "id": "report-23",
    "type": "live-activitystatus-by-user",
    "activity": {
        "id": "itemassessdemo",
        "name": "Demo Test"
    },
    "show_user_selectors" : true,
    "show_action_controls" : true,
    "display_activity": true,
    "users": [
        {
            "id": "brianmoser",
            "name": "Brian Moser",
            "hash": "7224f1cd26c7eaac4f30c16ccf8e143005734089724affe0dd9cbf008b941e2d"
        },
        {
            "id": "walterwhite",
            "activity": {
                "id": "myactivitydemo",
                "name": "My Demo Activity"
            },
            "name": "Walter White",
            "hash": "fd1888ffc8cf87efb4ab620401130c76fc8dff5ca04f139e23a7437c56f8f310"
        }
    ]
}

Attributes - Live Activity Status by User

id

type

show_user_selectors

show_action_controls

control_events

activity

The global activity config to apply to each user in the report.

display_activity

users

An array of one or more user objects:

Example - Activity Summary by Group

{
    "id":    "activity-summary-by-group-report",
    "type":  "activity-summary-by-group",
    "dataset_id": "616ee247-efb1-4448-8c61-00a1dc5f8e9b",
    "group_path": [],
    "columns": [
        {
            "type": "group_name",
            "label": "Group name"
        },
        {
            "type": "numeric",
            "field": "population",
            "label": "Students"
        },
        {
            "type": "numeric",
            "field": "lowest_percent",
            "label": "Lowest score %"
        },
        {
            "type": "numeric",
            "field": "highest_percent",
            "label": "Highest score %"
        },
        {
            "type": "numeric",
            "field": "mean_percent",
            "label": "Average score %"
        },
        {
            "type": "numeric",
            "field": "median_percent",
            "label": "Median score %"
        },
        {
            "type": "numeric",
            "field": "p75_percent",
            "label": "75th percentile"
        }
    ]
}

Attributes - Activity Summary by Group

id

The ID attribute of the HTML hook for this report.

type

The type of this report.

dataset_id

Specifies the dataset to render in this report. The aggregate reports implementation guide describes how to create a new dataset. The type of the specified dataset must be "activity-summary-by-group".

group_path

Array of string group names indicating the group path which should initially display upon load. The root group path [] is displayed by default.

always_show_group_ancestors

Flag that specifies whether or not to display the ancestor rows for the current group in the report when navigating down the group hierarchy.

columns

If provided, specifies an array of ColumnDefinition objects defining which of the dataset's fields should be displayed when viewing group-level data. A custom header label can be specified for each column too. By default, the report will display all fields contained in the dataset using the default header labels for those fields.

See the columns reference page for detailed information on the available column types and their properties.

user_columns

If provided, specifies an array of ColumnDefinition objects defining which of the dataset's fields should be displayed when viewing user-level data. A custom header label can be specified for each column too. By default, the report will display all fields contained in the dataset using the default header labels for those fields.

See the columns reference page for detailed information on the available column types and their properties.

render

Events - Activity Summary by Group

Example - Sessions Summary by Group

{
    "id":    "sessions-summary-by-group-report",
    "type":  "sessions-summary-by-group",
    "dataset_id": "8a280519-f779-445a-9116-8440512b28ad",
    "group_path": [],
    "columns": [
        {
            "type": "group_name",
            "label": "Group name"
        },
        {
            "type": "numeric",
            "field": "population",
            "label": "Students"
        },
        {
            "type": "numeric",
            "field": "lowest_percent",
            "label": "Lowest score %"
        },
        {
            "type": "numeric",
            "field": "highest_percent",
            "label": "Highest score %"
        },
        {
            "type": "numeric",
            "field": "mean_percent",
            "label": "Average score %"
        },
        {
            "type": "numeric",
            "field": "median_percent",
            "label": "Median score %"
        },
        {
            "type": "numeric",
            "field": "p75_percent",
            "label": "75th percentile"
        }
    ]
}

Attributes - Sessions Summary by Group

id

The ID attribute of the HTML hook for this report.

type

The type of this report.

dataset_id

Specifies the dataset to render in this report. The aggregate reports implementation guide describes how to create a new dataset. The type of the specified dataset must be "sessions-summary-by-group".

group_path

Array of string group names indicating the group path which should initially display upon load. The root group path [] is displayed by default.

always_show_group_ancestors

Flag that specifies whether or not to display the ancestor rows for the current group in the report when navigating down the group hierarchy.

columns

If provided, specifies an array of ColumnDefinition objects defining which of the dataset's fields should be displayed when viewing group-level data. A custom header label can be specified for each column too. By default, the report will display all fields contained in the dataset using the default header labels for those fields.

See the columns reference page for detailed information on the available column types and their properties.

user_columns

If provided, specifies an array of ColumnDefinition objects defining which of the dataset's fields should be displayed when viewing user-level data. A custom header label can be specified for each column too. By default, the report will display all fields contained in the dataset using the default header labels for those fields.

See the columns reference page for detailed information on the available column types and their properties.

render

Events - Sessions Summary by Group

Example - Item Scores by Tag by User

{
    "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 - Item Scores by Tag by User

id

type

items_tags_live_dataset_reference

session_items_live_dataset_reference

users

An array of one or more user objects:

row_tag_type

column_tag_types

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

session_statuses

Array containing strings of sessions_statuses to include.

session_tags

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

item_tags

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

activity_ids

A set of activity IDs for optional filtering.

min_time_started

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.

max_time_started

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.

render

tag_labels

Example - Response Analysis by Item

{
    "reports": [
        {
          "id": "response-analysis-by-item-report",
          "type": "response-analysis-by-item",
          "question_source": "original",
          "session_ids": [
                "c8df0f45-2bfd-4d6c-9de1-20200224c001",
                "c8df0f45-2bfd-4d6c-9de1-20200224c002",
                "c8df0f45-2bfd-4d6c-9de1-20200224c003",
                "c8df0f45-2bfd-4d6c-9de1-20200224c004",
                "c8df0f45-2bfd-4d6c-9de1-20200224c005",
                "c8df0f45-2bfd-4d6c-9de1-20200224c006",
                "c8df0f45-2bfd-4d6c-9de1-20200224c007",
                "c8df0f45-2bfd-4d6c-9de1-20200224c008",
                "c8df0f45-2bfd-4d6c-9de1-20200224c009",
                "c8df0f45-2bfd-4d6c-9de1-20200224c010",
                "c8df0f45-2bfd-4d6c-9de1-20200224c011",
          ],
          "users": [
                {"id": "user_20200224a_00001", "name": "Milhouse Vanhouten"},
                {"id": "user_20200224c_00002", "name": "Bart Simpson"},
                {"id": "user_20200224c_00003", "name": "Sherri Mackleberry"},
                {"id": "user_20200224c_00004", "name": "Nelson Muntz"},
                {"id": "user_20200224c_00005", "name": "Terri Mackleberry"},
                {"id": "user_20200224c_00006", "name": "Lewis Clark"},
                {"id": "user_20200224c_00007", "name": "Adrian Belew"},
                {"id": "user_20200224c_00008", "name": "Martin Prince"},
                {"id": "user_20200224c_00009", "name": "Wendell Borton"},
                {"id": "user_20200224c_00010", "name": "Nina Skalka"},
                {"id": "user_20200224c_00011", "name": "Sophie Jensen"}
          ],
          "item_reference_map": [
            {"reference": "20200224_responseAnalysis_i01", "name": "Item 1"},
            {"reference": "20200224_responseAnalysis_i02", "name": "Item 2"},
            {"reference": "20200224_responseAnalysis_i03", "name": "Item 3"},
            {"reference": "20200224_responseAnalysis_i04", "name": "Item 4"},
            {"reference": "20200224_responseAnalysis_i05", "name": "Item 5"},
            {"reference": "20200224_responseAnalysis_i06", "name": "Item 6"},
            {"reference": "20200224_responseAnalysis_i07", "name": "Item 7"},
            {"reference": "20200224_responseAnalysis_i08", "name": "Item 8"},
            {"reference": "20200224_responseAnalysis_i09", "name": "Item 9"},
            {"reference": "20200224_responseAnalysis_i10", "name": "Item 10"}
          ],
          "render": true
        }
    ]
}

Attributes - Response Analysis by Item

id

type

session_ids

users

An array of one or more user objects:

question_source

Version added: v2021.3.LTS

item_reference_map

An array of one or more objects providing user-friendly names for the Items in the sessions.

enable_histograms

Version added: v2020.2.LTS

render