The savedQuery() GraphQL query is used to retrieve a saved query.

For more information on saved queries, see the User Functions (Saved Searches) reference page where saved queries are discussed. Also, look at the Searching Data documentation page as it relates to recent queries and saving queries.

Syntax

Below is the syntax for the savedQuery() query field:

graphql
savedQuery(
      id: string!
   ): SavedQuery!

Returned Datatypes

The returned datatype savedQuery() has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SavedQuery

ParameterTypeRequired[a]DefaultDescription
templateYamlstringyes A YAML formatted string that describes the saved query.
idstringyes The unique identifier for the saved query.
namestringyes The name of the saved query.
displayNamestringyes The display name of the saved query.
queryHumioQueryyes The saved query itself (see HumioQuery Table).
isStarredbooleanyes Whether the saved query has been marked with a star.
widgetTypestringyes The type of widget used with the saved query.
optionsJSONyes Options related to the saved query, in JSON form.
packagePackageInstallation  The package, if there is one, in which the saved query is included (see PackageInstallation Table).
descriptionstring  A description of the saved query.
assetTypeAssetTypeyes A list of related asset types (see AssetType Table). This enumerated datatype has been deprecated and will be removed in version 1.136 of LogScale.

[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.