Dashboard
GET
5 endpoints
/api/v3/dashboard/{dashboardId}/share
GetDashboardShareV3
Get the individual users and user groups a dashboard is shared with
For a dashboard to be returned you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v3/dashboard
GetDashboardsV3
Retrieves an array of dashboards. The array of dashboards can be filtered by a number of criteria. See the filter property for more details
For a dashboard to be returned you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v3/dashboard/{dashboardId}
GetDashboardV3
Retrieves a dashboard.
For a dashboard to be returned you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v3/dashboard/{dashboardId}/widget
GetDashboardWidgetsV3
Get all widgets on a dashboard
For a dashboard to be returned you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v202208/dashboard/{dashboardId}/mapsetting
GetMapDashboardSettingsV202208
Gets the current display settings and filters for a specific map dashboard. Cannot be used to retreive settings for a standard dashboard.
POST
3 endpoints
/api/v3/dashboard/{dashboardId}/widget
AddWidgetV3
Add a widget to a dashboard
To add widgets to a dashboard you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you
/api/v3/dashboard/{dashboardId}/copy
CopyDashboardV3
Copy a dashboard
To copy a dashboard you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v3/dashboard
CreateDashboardV3
Creates a dashboard
PUT
7 endpoints
/api/v3/dashboard/{dashboardId}/visible
DashboardActionVisibleV3
Update the visibility of a dashboard for the current user
This must be a dashboard you can see
Which means you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps View permission and the dashboard is shared with you
/api/v202208/dashboard/{dashboardId}/publicsetting
EditDashboardSettingsV202208
Edits the public display settings for a dashboard. Settings can only be applied to public dashboards. Filter settings cannot be applied to Map dashboards.
To apply these settings, you must have the PublicDashboardsOrMaps Manage permission.
You must also have either created the dashboard
or have DashboardAdministrator Manage and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you
/api/v3/dashboard/{dashboardId}/share
EditDashboardShareV3
Update the shared users and user groups for a dashboard
To remove sharing completely set SharedWithEveryone to false, SharedUserIds to [], and SharedUserGroupIds to []
You must have created the dashboard and have SharedDashboardsOrMaps Create permission
or have DashboardAdministrator Manage permission and the dashboard must be shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
/api/v3/dashboard/{dashboardId}
EditDashboardV3
Edit a dashboard
To edit a dashboard you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you
/api/v202208/dashboard/{dashboardId}/widget
EditDashboardWidgetsV202208
Reorder, edit, and delete specific widgets on a dashboard.
To edit dashboard widgets you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you
/api/v3/dashboard/{dashboardId}/widget
Deprecated
EditDashboardWidgetsV3
Reorder, edit, and delete specific widgets on a dashboard.
To edit dashboard widgets you must have created the dashboard
or have DashboardAdministrator Manage permission and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you
/api/v202208/dashboard/{dashboardId}/mapsetting
EditMapDashboardSettingsV202208
Applies display settings and filters to a map dashboard. These settings are specific to map dashboards, and cannot be applied to standard dashboards.
To apply these settings, You must also have either:
Created the dashboard
or have DashboardAdministrator Manage and the dashboard is shared at all
or have DashboardAdministrator Manage permission and the dashboard is public
or have SharedDashboardsOrMaps Edit permission and the dashboard is shared with you