addDashboardLabel( )

Attention

Under Development

Our GraphQL pages are currently under development. The content, links, tables, and structure of this material may change without notice.

The adddashboardlabel GraphQL mutation field can be used to add a label to a dashboard.

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

Syntax

Below is the syntax for the adddashboardlabel mutation field:

addDashboardLabel(id: String! label: String!): Dashboard!
Given Data Types

For the input (i.e., addDashboardLabel), there are a few parameters that may be given. Below is a list of them along with a description of each:

Table: addDashboardLabel

ParameterTypeRequired[a]DefaultDescription
idstringyes datatype mutation-adddashboardlabel The unique identifier of the dashboard.
labelstringyes The label to add to the dashboard.

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


Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, Dashboard. Below is a list of the parameters of that datatype:

Table: Dashboard

ParameterTypeRequired[a]DefaultDescription
templateYamlstringyes datatype dashboard A YAML formatted string that describes the dashboard. It does not contain links or permissions, and is safe to share and use for making copies of a dashboard.
displayNamestringyes The display name of the dashboard.
labelsstringyes Any labels associated with the dashboard.
widgetsWidgetyes Widgets for the dashboard. See Widget Table.
readOnlyTokensDashboardLinkyes text See DashboardLink Table.
filtersDashboardFilteryes The filters used with the dashboard. See DashboardFilter Table.
parametersDashboardParameteryes List of dashboard parameters. See DashboardParameter Table.
updateFrequencyDashboardUpdateFrequencyTypeyes text See the explanations under the DashboardParameter Table.
isStarredbooleanyes Whether the dashboard is marked with a star.
defaultFilterDashboardFilter  The default filter used with the dashboard. See DashboardFilter Table.
defaultSharedTimeStartstringyes text
defaultSharedTimeEndstringyes text
timeJumpSizeInMsinteger  text
defaultSharedTimeIsLivebooleanyes text Deprecated since July 20, 2022. The concept of liveness has been removed from the time selector. Use updateFrequency instead.
defaultSharedTimeEnabledbooleanyes text
searchDomainSearchDomainyes The search domain for the dashboard. See SearchDomain Table.
packagePackageInstallationyes The package, if there is one, in which the dashboard is included. See PackageInstallation Table.
idstringyes The unique identifier for the dashboard.
namestringyes The name of the dashboard.
descriptionstring  A description of the dashboard.
assetTypeAssetTypeyes The related asset type: ScheduledSearch, Action, File, Alert, Parser, SavedQuery, or Dashboard.

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