Public Method Reports API

addUsers()

Subscribe to and control additional user IDs.

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

Arguments

  • userArray array[userObject]
    Array of users to be added to the report.

Return value

None (undefined).

Type definitions

userObject object

An object containing the user information required to add that user to a live progress report.
  • id string
    The user id that should be tracked in this report. This is the same user_id used when initializing the Items API.
  • name string
    The user name to be displayed in the UI.
  • hash string
    A sha256 hash of the user_id and consumer secret.