Progress by Tag by User Report

Shows a breakdown of learners' progress and performance within a set of Tagged content for a group of users.

You would want to use this to review and compare the progress of learners over a series of topics within a specific subject and content pool. This can also be used to identify learners that are lagging behind or are struggling in a particular subject area, for example.

The set of content is specified as one specific Tag type within a Tag hierarchy (a pre-configured set of Tags).

For example, imagine a given Tag hierarchy defines ContentPool Tags (such as: formative, quiz, assessment) each comprising a set of subjects (such as: English, math, history), each comprising a set of topic areas (such as: arithmetic, algebra, geometry). If the report is given the Tag path ContentPool:Formative -> Subject:Math, then the report will show each topic area of formative math. Also each learner's percentage score is shown as correct, incorrect, and incomplete within the topic area. Each percentage is in proportion to all formative math Items in the Item bank for that topic area.

Scoring details

The report uses partial Item scoring, so the progress percentage is calculated as the sum of scores on completed Items, including any partially correct scores, as a proportion of the maximum possible score if all Items in the topic area were completed and fully correct. If the learner has responded to an Item more than once, the most recent score is used.

Unattempted Items count as "incomplete", as does any Item that has never appeared in a saved session for that user.

Examples

// Example report configuration
{
    "id": "report-9",
    "type": "progress-by-tag-by-user",
    "users": [
        {"id": "$ANONYMIZED_USER_ID1", "name": "John Smith"},
        {"id": "$ANONYMIZED_USER_ID2", "name": "Sarah Jane"}
    ],
    "hierarchy_reference": "CCSS"
}

Attributes

• type string

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

• id string

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

• hierarchy_reference string

  The reference of the Tag hierarchy to show progress against.

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

  • id string

    The ID of the user (learner).

  • name string

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

• tag_hierarchy_path array[TagsV2]

  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.

  See Understanding Tag Formats for Content Creation and Filtering for more information on the TagsV2 format.

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

• organisation_id integer

  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 initializing the learner sessions.

  The API 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.

  Default: The API Consumer's primary organisation.

• ui_clickable object

  Toggle clickable styling for certain elements.

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

  • user boolean

    Clickable style for user names.

  • tag boolean

    Clickable style for Tag names.

  • progress boolean

    Clickable style for progress cells.

• 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