The savedQuery()
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.
Below is the syntax for the savedQuery()
savedQuery(
id : string!
) : SavedQuery!
Below is an example of how this query field might be used:
Show:
Raw Mac OS or Linux (curl) Mac OS or Linux (curl) One-line Windows Cmd and curl Windows Powershell and curl Perl Python Node.js
Raw query {
savedQuery( id : "1234" )
{ name, displayName, isStarred,
query { arguments{ key, value} } }
} Mac OS or Linux (curl) curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}
EOFMac OS or Linux (curl) One-line curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d @- << EOF
{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}
EOFWindows Cmd and curl curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
-H "Authorization: Bearer $TOKEN" ^
-H "Content-Type: application/json" ^
-d @'{"query" : "query { ^
savedQuery(id:\"1234\") ^
{ name, displayName, isStarred, ^
query{arguments{key, value}} } ^
}" ^
} 'Windows Powershell and curl curl.exe -X POST
-H "Authorization: Bearer $TOKEN "
-H "Content-Type: application/json"
-d '{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}'
"$YOUR_LOGSCALE_URL /graphql" Perl
use HTTP::Request;
use LWP;
my $INGEST_TOKEN = "TOKEN" ;
my $uri = '$YOUR_LOGSCALE_URL/graphql' ;
my $json = '{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}' ;
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
import requests
url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}'''
resp = requests.post(url,
data = mydata,
headers = {
"Authorization" : "Bearer $TOKEN" ,
"Content-Type" : "application/json"
}
)
print (resp.text)Node.js const https = require ('https' );
const data = JSON .stringify (
{"query" : "query {
savedQuery(id:\"1234\")
{ name, displayName, isStarred,
query{arguments{key, value}} }
}"
}
);
const options = {
hostname : '$YOUR_LOGSCALE_URL/graphql' ,
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 ();
The returned datatype savedQuery()
Table: SavedQuery
Parameter Type Required Default Stability Description Some arguments may be required, as indicated in the Required Table last updated: Mar 28, 2025 allowedActions[AssetAction yes PreviewThe allowed asset actions. See AssetAction descriptionstring Long-TermA description of the saved query. displayNamestring yes Long-TermThe display name of the saved query. idstring yes Long-TermThe unique identifier for the saved query. interactions[QueryBasedWidgetInteraction yes Long-TermThe interactions of the saved query. See QueryBasedWidgetInteraction isStarredboolean yes Long-TermWhether the saved query has been marked with a star. namestring yes Long-TermThe name of the saved query. optionsJSONyes Long-TermOptions related to the saved query, in JSON form. 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 queryHumioQueryyes Long-TermThe saved query itself. See HumioQuery resourcestring yes Short-TermThe resource identifier for this saved query. widgetTypestring yes Long-TermThe type of widget used with the saved query. yamlTemplateYAMLyes Long-TermA YAML formatted string that describes the saved query. This replaced templateYaml starting in LogScale version 1.225.
