Skip to main content

dashboards

Overview

Namedashboards
TypeResource
Idsumologic.dashboards.dashboards

Fields

NameDatatypeDescription
idstringUnique identifier for the dashboard. This id is used to get detailed information about the dashboard, such as panels, variables and the layout.
descriptionstringDescription of the dashboard.
contentIdstringContent identifier for the dashboard. This id is used to connect to the Sumo Content Library and get general metadata about the dashboard. Use this id if you want to search for dashboards in Sumo folders.
domainstringIf set denotes that the dashboard concerns a given domain (e.g. aws, k8s, app).
folderIdstringThe identifier of the folder to save the dashboard in. By default it is saved in your personal folder.
hierarchiesarrayIf set to non-empty array denotes that the dashboard concerns given hierarchies.
layoutobject
panelsarrayPanels in the dashboard.
refreshIntervalintegerInterval of time (in seconds) to automatically refresh the dashboard. A value of 0 means we never automatically refresh the dashboard. Allowed values are 0, 30, 60, 120, 300, 900, 3600, 86400`.
scheduleIdstringScheduled report identifier for the dashboard. Only most recently modified report schedule is rerun per dashboard. This id is used to manage the schedule details through the scheduled report API.
themestringTheme for the dashboard. Either Light or Dark.
timeRangeobject
titlestringTitle of the dashboard.
topologyLabelMapobjectMap of the topology labels. Each label has a key and a list of values. If a value is *, it means the label will match content for all values of its key.
variablesarrayVariables to apply to the panels.

Methods

NameAccessible byRequired ParamsDescription
getDashboardSELECTid, regionGet a dashboard by the given identifier.
listDashboardsSELECTregionList all dashboards under the Personal folder created by the user or under folders viewable by user.
createDashboardINSERTdata__timeRange, data__title, regionCreates a new dashboard.
deleteDashboardDELETEid, regionDelete a dashboard by the given identifier.
updateDashboardEXECid, data__timeRange, data__title, regionUpdate a dashboard by the given identifier.