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:
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:
mutation {
updateSettings(
defaultTimeZone: "UTC-5"
)
{ defaultTimeZone }
}
{
"data": {
"updateSettings": {
"defaultTimeZone": "UTC-2"
}
}
}
Given Datatypes
The given datatype UiTheme has is an enumerated list of values:
Table: UiTheme
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
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 | |||||
Auto | boolean | Long-Term | The display is set automatically to either light or dark mode. | ||
Dark | boolean | Long-Term | The user interface display is dark mode. | ||
Light | boolean | Long-Term | The user interface display is light mode. |
The given datatype FeatureAnnouncement has is also an enumerated list of values:
Table: FeatureAnnouncement
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
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 | |||||
AggregateAlertOverview | boolean | Preview | Whether the feature announcement is an aggregate alert overview . | ||
AggregateAlertSearchPage | boolean | Preview | Whether the feature announcement is an aggregate alert search page. | ||
FetchMoreOnFieldsPanel | boolean | Preview | Whether the feature announcement is a request to fetch more on fields panel. | ||
FieldInteractions | boolean | Preview | Whether the feature announcement are field interactions. | ||
FilterMatchHighlighting | boolean | Preview | Whether the feature announcement is a filter matching highlighting. | ||
FleetRemoteUpdatesAndGroups | boolean | Preview | Whether the feature announcement is related to Fleet remote updates and groups. | ||
Interactions | boolean | Preview | Whether the feature announcement has to do with interactions. | ||
OrganizationOwnedQueries | boolean | Preview | Whether the feature announcement has to do with an organization's owned queries. | ||
PuffinRebranding | boolean | Preview | Whether the feature announcement is a Puffin rebranding. | ||
ToolPanel | boolean | Preview | Whether 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
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
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 | |||||
defaultTimeZone | string | Long-Term | Default timezone preference for user. If not set, the default timezone is no longer taken from the organization. | ||
featureAnnouncementsToShow | [FeatureAnnouncement ] | yes | Preview | List of feature announcements to show. See FeatureAnnouncement . This is a preview and subject to change. | |
isAutomaticHighlightingEnabled | boolean | yes | Preview | Whether automatic highlighting on the search page is enabled. This is a preview and subject to change. | |
isAutomaticSearchEnabled | boolean | yes | Short-Term | Whether the automatic search been enabled. | |
isCommunityMessageDismissed | boolean | yes | Short-Term | Whether the community message has been dismissed. | |
isDarkModeMessageDismissed | boolean | yes | Short-Term | Whether the dark-mode message has been dismissed. | |
isEventListOrderedWithNewestAtBottom | boolean | yes | Short-Term | Whether there is an event list, ordered with newest last. | |
isFieldPanelOpenByDefault | boolean | yes | Short-Term | Whether the field panel is open by default. | |
isGettingStartedMessageDismissed | boolean | yes | Short-Term | Whether the 'Getting Started' message has been dismissed. | |
isPackageDocsMessageDismissed | boolean | yes | Short-Term | Whether the package documentation message has been dismissed. | |
isQuickStartCompleted | boolean | yes | Long-Term | Whether the quick start has been completed. | |
isWelcomeMessageDismissed | boolean | yes | Short-Term | Whether the welcome message has been dismissed. | |
starredAlerts | [string] | yes | Deprecated | List 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-Term | List of dashboards that have been marked with a star. | |
starredSearchDomains | [string] | yes | Long-Term | List of searchdomains that have been marked with a star. | |
uiTheme | UiTheme | yes | Long-Term | The user interface theme choice. See UiTheme . |