Progress by Tag Report Deprecated

For a single user, shows a breakdown of their exposure and performance within a set of content. The set of content is specified using a Tag hierarchy (a pre-configured set of Tags). The first two levels of the Tag hierarchy are used.

As an example, imagine a given Tag hierarchy defines subject Tags (for e.g. math, English) each comprising a set of topic areas (arithmetic, algebra, geometry).

The report shows the percentage of Items the user has seen in each subject. The percentage is in proportion to all Items Tagged with that subject in the entire Item bank. The report also shows how many Items the user got correct in that subject, as a percentage of all Items they've seen for the subject. An Item counts as "seen" if it appeared in at least one of the user's saved sessions.

Drilling down on a subject shows how many Items the user got correct in each topic area of that subject, as a percentage of all Items they've seen for the topic area.

The report uses dichotomous Item scoring to calculate the number of correct Items, so partially correct Items are counted as incorrect for the calculation of the "% correct" figures. If the user has responded to an Item more than once, the most recent score is used.

Examples

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

Attributes

• type string

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

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

• user_id string

  The ID of the user to show progress for.

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

• 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

• ui string

  The user interface style for this report.

  Default: table

  Possible values

  • table
  • bar-chart