API Stability Preview

The updateSettings() GraphQL mutation is used to set flags for user interface states and help messages. This field is a preview and not yet available.

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,
     automaticallyHighlighting: boolean,
     uiTheme: UiTheme
     isDarkModeMessageDismissed: boolean
     isResizableQueryFieldMessageDismissed: boolean,
     featureAnnouncementsToDismiss: [FeatureAnnouncement], 
     defaultTimeZone: String
   ): UserSettings!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  updateSettings( 
    defaultTimeZone: "UTC-5"
  ) 
  { defaultTimeZone }
}
Example Responses
Show:
json
{
  "data": {
    "updateSettings": {
      "defaultTimeZone": "UTC-2"
    }
  }
}

Given Datatypes

The given datatype UiTheme has is an enumerated list of values:

Table: UiTheme

ParameterTypeRequiredDefaultStabilityDescription
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 16, 2024
Autoboolean  Long-TermThe display is set automatically to either light or dark mode.
Darkboolean  Long-TermThe user interface display is dark mode.
Lightboolean  Long-TermThe user interface display is light mode.

The given datatype FeatureAnnouncement has is also an enumerated list of values:

Table: FeatureAnnouncement

ParameterTypeRequiredDefaultStabilityDescription
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 13, 2024
AggregateAlertOverviewboolean  PreviewWhether the feature announcement is an aggregate alert overview .
AggregateAlertSearchPageboolean  PreviewWhether the feature announcement is an aggregate alert search page.
FetchMoreOnFieldsPanelboolean  PreviewWhether the feature announcement is a request to fetch more on fields panel.
FieldInteractionsboolean  PreviewWhether the feature announcement are field interactions.
FilterMatchHighlightingboolean  PreviewWhether the feature announcement is a filter matching highlighting.
FleetRemoteUpdatesAndGroupsboolean  PreviewWhether the feature announcement is related to Fleet remote updates and groups.
Interactionsboolean  PreviewWhether the feature announcement has to do with interactions.
OrganizationOwnedQueriesboolean  PreviewWhether the feature announcement has to do with an organization's owned queries.
PuffinRebrandingboolean  PreviewWhether the feature announcement is a Puffin rebranding.
ToolPanelboolean  PreviewWhether the feature announcement is related to a Tool Panel item.

Returned Datatypes

The returned datatype UserSettings has several parameters. Below is a list of them along with a description of each:

Table: UserSettings

ParameterTypeRequiredDefaultStabilityDescription
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: Apr 3, 2025
defaultTimeZonestring  Long-TermDefault timezone preference for user. If not set, the default timezone is no longer taken from the organization.
featureAnnouncementsToShow[FeatureAnnouncement]yes PreviewList of feature announcements to show. See FeatureAnnouncement. This is a preview and subject to change.
isAutomaticHighlightingEnabledbooleanyes PreviewWhether automatic highlighting on the search page is enabled. This is a preview and subject to change.
isAutomaticSearchEnabledbooleanyes Short-TermWhether the automatic search been enabled.
isCommunityMessageDismissedbooleanyes Short-TermWhether the community message has been dismissed.
isDarkModeMessageDismissedbooleanyes Short-TermWhether the dark-mode message has been dismissed.
isEventListOrderedWithNewestAtBottombooleanyes Short-TermWhether there is an event list, ordered with newest last.
isFieldPanelOpenByDefaultbooleanyes Short-TermWhether the field panel is open by default.
isGettingStartedMessageDismissedbooleanyes Short-TermWhether the 'Getting Started' message has been dismissed.
isPackageDocsMessageDismissedbooleanyes Short-TermWhether the package documentation message has been dismissed.
isQuickStartCompletedbooleanyes Long-TermWhether the quick start has been completed.
isWelcomeMessageDismissedbooleanyes Short-TermWhether the welcome message has been dismissed.
starredAlerts[string]yes DeprecatedList of alerts that have been marked with a star. However, starring is no longer used in the UI and will be removed at the earliest in version 1.207.
starredDashboards[string]yes Long-TermList of dashboards that have been marked with a star.
starredSearchDomains[string]yes Long-TermList of searchdomains that have been marked with a star.
uiThemeUiThemeyes Long-TermThe user interface theme choice. See UiTheme.