/dashboard
Methods
Gets the list of Dashboards
NOTE: If the Session User is an Admin, the response will be faked Dashboards.
Fields Parameter
Request Parameters
None
Expand Parameters
dashboardComponents
Filter Parameters
activated - the response returns an 'usable' object containing an array of objects with only activated Dashboard Tabs for the session user. This is not compatible with usable and/or manageable filters.
usable - The response will be an object containing an array of usable Dashboards. By default, both usable and manageable objects are returned.
manageable - The response will be an object containing all manageable Dashboards. By default, both usable and manageable objects are returned.
Example Response
Adds a Dashboard
Request Parameters
Example Response
/dashboard/{id}
Methods
Gets the Dashboard associated with {id}.
NOTE: If the Session User is an Admin, the response will be a faked Dashboard.
Fields Parameter
Request Parameters
None
Expand Parameters
dashboardComponents
Example Response
Edits the Dashboard associated with {id}, changing only the passed in fields.
NOTE #1: This is for patching the Dashboard tab, not the contained components.
NOTE #2: To activate, both activated="true" and the order parameter must be provided. To deactivate, only the activated="false" parameter (not the order) should be provided.
Request Parameters
(All fields are optional)
See /dashboard::POST for parameters.
Example Response
See /dashboard/{id}::GETDeletes the Dashboard associated with {id}, depending on access and permissions.
Request Parameters
Example Response
/dashboard/{id}/copy
Methods
Copies the Dashboard associated with {id}.
Request Parameters
Example Response
/dashboard/import
Methods
Imports a Dashboard
Request Parameters
Example Response
/dashboard/{id}/export
Methods
Exports the Dashboard associated with {id}.
Request Parameters
Example Response
/dashboard/{id}/share
Methods
Shares the Dashboard associated with {id}, depending on access and permissions