API Stability Long-Term

The setDefaultSavedQuery() GraphQL mutation is used to set the query that should be loaded on entering the search page in a specific view.

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
setDefaultSavedQuery(
      input: SetDefaultSavedQueryInput!
   ): BooleanResultType!

Example

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

Raw
graphql
mutation {
  setDefaultSavedQuery(input:
     { viewName: "humio", 
       savedQueryId: "8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E"
     }
  )
  { result }
}
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" : "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}"
}
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" : "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}"
}
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" : "mutation { ^
  setDefaultSavedQuery(input: ^
     { viewName: \"humio\",  ^
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\" ^
     } ^
  ) ^
  { result } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}"
}'
    "$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 = "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}";
$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" : "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}"
}'''

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" : "mutation {
  setDefaultSavedQuery(input:
     { viewName: \"humio\", 
       savedQueryId: \"8V42c6qN2o5NdDe9wRV7kHU5nUq4sx6E\"
     }
  )
  { result }
}"
}
);


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": {
    "setDefaultSavedQuery": {
      "result": true
    }
  }
}

Given Datatype

For input datatype, you'll have to give name of the view and the unique identifier of the saved query to set as the default. The table below provides more information:

Table: SetDefaultSavedQueryInput

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 19, 2024
savedQueryIdstring  Long-TermThe unique identifier of the saved query to make default.
viewNamestringyes Long-TermThe name of the view related to the saved query.

Returned Datatype

For this datatype, the only result is whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType

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 24, 2024
resultsbooleanyes Long-TermWhether the mutation was performed.