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

For more information on creating dashboards, see the Creating 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

ParameterTypeRequired[a]DefaultDescription
searchDomainNamestringyes The name of the search domain associated with the dashboard to create.
namestringyes The name of the dashboard to create.
labels[string]yes A list of labels to use with the dashboard.
widgets[WidgetInput]yes The widgets to include in the dashboard (see WidgetInput Table).
links[LinkInput]yes A list of links for the dashboard. (see LinkInput Table).
defaultFilterIdstring  The unique identifier for the default filter.
filters[FilterInput]yes A list of filters to use with the dashboard. (see FilterInput Table).
parameters[ParameterInput]yes A list of parameters to use with the dashboard.
descriptionstring  A description of the dashboard.

[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 CreateDashboardMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: CreateDashboardMutation

ParameterTypeRequired[a]DefaultDescription
dashboardDashboardyes The dashboard to create (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.