The updateDashboard() GraphQL mutation may be used to update a dashboard in LogScale.

For more information on dashboards, see the Dashboards & Widgets documentation page.

Syntax

Below is the syntax for the updateDashboard() mutation field:

graphql
updateDashboard(
      input: UpdateDashboardInput!
   ): UpdateDashboardMutation!

Given Datatypes

For the given datatype, UpdateDashboardInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: UpdateDashboardInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
defaultFilterIdstring  The unique identifier for the default filter.
defaultSharedTimeEnabledboolean  Whether the default shared time is enabled.
defaultSharedTimeEndstring  The updated default shared time end for the dashboard.
defaultSharedTimeStartstring  The updated default shared time start for the dashboard.
descriptionstring  An updated description of the dashboard.
filters[FilterInput]yes The filters for the dashboard. See FilterInput.
idstringyes The unique identifier of the dashboard to update.
labels[string]yes The labels for the dashboard being updated.
links[LinkInput]yes All dashboard links. See LinkInput.
namestring  The name of the dashboard to update.
parameters[ParameterInput]yes The dashboard parameters. See ParameterInput.
timeJumpSizeInMsinteger  The skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyInput  The frequency in which the dashboard is to be updated. See DashboardUpdateFrequencyInput.
widgets[WidgetInput]yes The dashboards widgets. See WidgetInput.

Returned Datatypes

The returned datatype UpdateDashboardMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UpdateDashboardMutation

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 4, 2024
dashboardDashboardyes The dashboard to update. See Dashboard.