Dashboard Viewers

Manage the viewers associated with a dashboard.

To change the viewers on dashboards, use Dashboard Uploads

Linked From:

• API Root

Dashboard Viewer

Field	Description
id	The ID for the user.
name	The name of the user.
sis_id	The SIS ID for the user.
is_ally	Whether or not the viewer is an ally.

Note

To create dashboard viewers, use the Dashboard Upload POST endpoint.

GET

The GET method is used to fetch a paginated collection of a dashboards viewers. The viewers are returned ordered by id in ascending order.

The GET method supports the following query string parameters:

Parameter	Description
cursor	A unique identifier to fetch the next or previous page. It is supplied in the response as a way to navigate pages.
q	Filter down to users whose name contains the term.
id	Filter down to users whose ID matches this value.
sis_id	Filter down to users whose SIS ID matches this value.
is_ally	Filter down to only allies if True. Filter down to only viewers if False. Otherwise return all.
account	Filter down to viewers on dashboards for the given account and all of its subaccounts. The account must be a subaccount of the account associated with your API token.

Accepted Request Content-Types:

application/json

Available Response Content-Types:

application/json

Example Request

URL:

/detective/api/v2/dashboard/<dashboard_id>/viewer/

Content-Type:

application/json

Example Success Response

URL:

/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/viewer/

Status:

200 OK Request

Content-Type:

application/json

{
  "next": "https://apps.aspiredu.com/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/viewer/?cursor=UNIQUE_STRING",
  "previous": "https://apps.aspiredu.com/detective/api/v2/dashboard/00000000-0000-0000-0000-000000000000/viewer/?cursor=DIFFERENT_UNIQUE_STRING",
  "results": [
    {
      "id": "10",
      "sis_id": "10",
      "name": "John Jacobs",
      "is_ally": true
    },
    {
      "id": "1",
      "sis_id": "1",
      "name": "Jill Jillian",
      "is_ally": false
    }
  ]
}