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

ParameterTypeRequired[a]DefaultDescription
idstringyes The unique identifier of the dashboard to update.
namestring  The name of the dashboard to update.
labels[string]yes The labels for the dashboard being updated.
widgets[WidgetInput]yes The dashboards widgets (see WidgetInput Table).
links[LinkInput]yes All dashboard links (see LinkInput Table).
defaultFilterIdstring  The unique identifier for the default filter.
filters[FilterInput]yes The filters for the dashboard (see FilterInput Table).
parameters[ParameterInput]yes The dashboard parameters (see ParameterInput Table).
descriptionstring  An updated description of the dashboard.
timeJumpSizeInMsinteger  The skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyInput  The frequency in which the dashboard is to be updated (see DashboardUpdateFrequencyInput Table).
defaultSharedTimeStartstring  The updated default shared time start for the dashboard.
defaultSharedTimeEndstring  The updated default shared time end for the dashboard.
defaultSharedTimeEnabledboolean  Whether the default shared time is enabled.

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
groupDashboardyes The unassigned dashboard (see Dashboard Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.