The updateSettings() GraphQL mutation is used to set flags for User Interface states and help messages. This field is not yet available. It's described here as a preview. This mutation is dictated by the needs of the LogScale User Interface, and may include unstable or ephemeral settings.

For more information on configuring all aspects of LogScale, see the Configuration Settings reference section.

Syntax

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

graphql
updateSettings(
     isWelcomeMessageDismissed: boolean
     isGettingStartedMessageDismissed: boolean
     isCommunityMessageDismissed: boolean
     isPackageDocsMessageDismissed: boolean
     isEventListOrderedWithNewestAtBottom: boolean
     isFieldPanelOpenByDefault: boolean
     automaticallySearch: boolean
     uiTheme: UiTheme
     isDarkModeMessageDismissed: boolean
     isResizableQueryFieldMessageDismissed: boolean
   ): UserSettings!

Given and Returned Datatypes

The given datatype UiTheme is an enumerated list: Auto, Dark, or Light. The returned datatype UserSettings has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UserSettings

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
defaultTimeZonestring  Default timezone preference for user. If not set, the default timezone is no longer taken from the organization.
featureAnnouncementsToShow[FeatureAnnouncement]yes List of feature announcements to show. See FeatureAnnouncement. This is a preview and subject to change.
isAutomaticHighlightingEnabledbooleanyes Whether automatic highlighting on the search page is enabled. This is a preview and subject to change.
isAutomaticSearchEnabledbooleanyes Whether the automatic search been enabled.
isCommunityMessageDismissedbooleanyes Whether the community message has been dismissed.
isDarkModeMessageDismissedbooleanyes Whether the dark-mode message has been dismissed.
isEventListOrderedWithNewestAtBottombooleanyes Whether there is an event list, ordered with newest last.
isFieldPanelOpenByDefaultbooleanyes Whether the field panel is open by default.
isGettingStartedMessageDismissedbooleanyes Whether the 'Getting Started' message has been dismissed.
isPackageDocsMessageDismissedbooleanyes Whether the package documentation message has been dismissed.
isQuickStartCompletedbooleanyes Whether the quick start has been completed.
isResizableQueryFieldMessageDismissedbooleanyes Whether the resizable query field message has been dismissed. This has been deprecated and will be removed in version 1.136.
isWelcomeMessageDismissedbooleanyes Whether the welcome message has been dismissed.
starredAlerts[string]yes List of alerts that have been marked with a star.
starredDashboards[string]yes List of dashboards that have been marked with a star.
starredSearchDomains[string]yes List of searchdomains that have been marked with a star.
uiThemeUiThemeyes The user interface theme choice. See UiTheme.