Reports API Methods

Each of the user IDs provided will navigate to the specified item.

The assessment will be automatically started if the student is still on the intro item.

The item is specified by reference (a string) or number (a 1-indexed number).

Important Only applicable to the live-activity-status-by-user report.

Arguments

• userArray array[userObject]

  Array of users to be added to the report.

  The following properties are supported.

  • UserObject object

    An object containing the user information required to add that user to a live progress report.

    The following properties are supported.

    • id string

      The user ID that should be tracked in this report. This is the same user_id used when initializing the Items API in the assessment.

    • name string

      The name to be displayed in the live progress report UI.

    • hash string

      A SHA256 hash of the user_id and your consumer secret.

• itemObject object

  Object containing either an item_number or item_reference property.

  The following properties are supported.

  • item_number number

  • item_reference string

  • section_number number

Return value

None (undefined).