Sessions Summary by Group Report

Shows the performance for large groups of learners across one or more sessions.

You would want to use this to compare the performance across multiple sessions for a particular examination date where a large number of learners participated, for example.

User groupings are defined during report generation and can be used to analyze results by region, school, class, demographic traits, or any other arbitrary grouping. The report shows a configurable set of statistical measures about each group including the mean, median, percentile, standard deviation, and many others. See the full list of available fields.

Important The report is initialized with the dataset_id of a dataset created via Data API's /reports/datasets endpoints. The specified dataset must be of the type "sessions-summary-by-group".

See the article on Large Group Reporting for more information.

Related articles

• The load:data event, which fires when the report data has loaded.
• The change:data event, which fires when users take an action that causes the report to pull new information for this report.

Examples

// Example report configuration
{
    "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": "Learners"
        },
        {
            "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

• type string

  The type of this report. Must be "sessions-summary-by-group".

• id string

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

• dataset_id string

  Specifies the dataset to render in this report.

  The Large Group Report implementation guide describes how to create a new dataset. You must specify your Activities when creating the dataset.

  Important The type of the specified dataset must be "sessions-summary-by-group".

• always_show_group_ancestors boolean

  Controls whether or not to show the ancestor rows for the current group in the report when navigating within the group hierarchy.

  Default: false

• group_path array[string]

  An array of group names indicating the group path hierarchy which should initially be shown when the report has loaded.

• columns array[ColumnDefinition] | null

  Specifies an array of ColumnDefinition objects defining which of the dataset's fields should be shown when viewing group-level data.

  A custom header label can be specified for each column. By default, the report will show 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 array[ColumnDefinition] | null

  Specifies an array of ColumnDefinition objects defining which of the dataset's fields should be shown when viewing user-level data.

  A custom header label can be specified for each column. By default, the report will show 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 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