The createDashboard() GraphQL mutation may be used to create a dashboard in LogScale.

For more information on creating dashboards, see the Create Dashboards and Widgets documentation page. You may also want to look at the Dashboards & Widgets and Dashboards pages for related information.

Syntax

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

graphql
createDashboard(
      input: CreateDashboardInput!
   ): CreateDashboardMutation!

Given Datatypes

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

Table: CreateDashboardInput

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 17, 2024
defaultFilterIdstring  The unique identifier for the default filter.
descriptionstring  A description of the dashboard.
filters[FilterInput]yes A list of filters to use with the dashboard. See FilterInput.
labels[string]yes A list of labels to use with the dashboard.
links[LinkInput]yes A list of links for the dashboard. See LinkInput.
namestringyes The name of the dashboard to create.
parameters[ParameterInput]yes A list of parameters to use with the dashboard. See ParameterInput.
searchDomainNamestringyes The name of the search domain associated with the dashboard to create.
sections[SectionInput]yes A list of sections to use with the dashboard. See SectionInput.
updateFrequencyDashboardUpdateFrequencyInputyes The frequency with which to update the dashboard. See DashboardUpdateFrequencyInput.
widgets[WidgetInput]yes The widgets to include in the dashboard. See WidgetInput.

Returned Datatypes

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

Table: CreateDashboardMutation

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 24, 2024
dashboardDashboardyes The dashboard to create. See Dashboard.