API Stability Long-Term

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

Related to this query, there are several mutation fields: createSavedQuery(); updateSavedQuery(); and deleteSavedQueryV2() for creating, updating, and deleting saved queries. For creating them based on others, you can use copySavedQuery() for copying one, createSavedQueryFromTemplate() using a YAML template, and createSavedQueryFromPackageTemplate() from a template in a package. There is also setDefaultSavedQuery() for marking a saved query as the default, and the query savedQuery() to get a saved query.

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

Syntax

graphql
savedQuery(
     id: string!
   ): SavedQuery!

There is no special input datatype for this query field. You'll have to give the unique identifier for the saved query. To get that, you can use the savedQuery() query like the following:

graphql
query {
  repository( name: "humio" )
    {savedQueries { name, id } }
}

For the results, you can get a yaml template of the saved query, when and who created it, and much more. See the Returned Datatype section further down this page.

Example

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

Raw
graphql
query {
  savedQuery(id:"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn")
     { name, displayName,  
       query{ arguments{key, value} } }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\") ^
     { name, displayName,   ^
       query{ arguments{key, value} } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  savedQuery(id:\"gfgG8ElwbLUGQG2CFOJ6Jq6oyQ11zsWn\")
     { name, displayName,  
       query{ arguments{key, value} } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "savedQuery": {
      "name": "bobs_query",
      "displayName": "Bob's Query",
      "query": {
        "arguments": []
      }
    }
  }
}

Returned Datatype

With the returned datatype, you can get a yaml template of the saved query, when and who created it, and other related data. Below is a list of what's available, along with descriptions of them:

Table: SavedQuery

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 30, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction . This is a preview and subject to change.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the saved query. See AssetCommitMetadata.
descriptionstring  Long-TermA description of the saved query.
displayNamestringyes Long-TermThe display name of the saved query.
idstringyes Long-TermThe unique identifier for the saved query.
interactions[QueryBasedWidgetInteraction]yes Long-TermThe interactions of the saved query. See QueryBasedWidgetInteraction.
isStarredbooleanyes Long-TermWhether the saved query has been marked with a star.
labels[string]yes Long-TermThe labels associated with this saved query.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the saved query. See AssetCommitMetadata.
namestringyes Long-TermThe name of the saved query.
optionsJSONyes Long-TermOptions related to the saved query, in JSON form. JSON is a scalar.
packagePackageInstallation  Long-TermThe package, if there is one, in which the saved query is included. See PackageInstallation.
packageIdVersionedPackageSpecifier  Long-TermThe unique identifier of the package. VersionedPackageSpecifier is a scalar value.
queryHumioQueryyes Long-TermThe saved query itself. See HumioQuery.
resourcestringyes Short-TermThe resource identifier for this saved query.
widgetTypestringyes Long-TermThe type of widget used with the saved query.
yamlTemplateYAMLyes Long-TermA yaml formatted string that describes the saved query. YAML is a scalar. This replaced templateYaml starting in LogScale version 1.225.