Summary

For some repositories, you might have several saved queries for many reasons. They can be found by users in the UI. However, you may want some saved queries appear at the top of the list. To do that, you'll have to add a star by the saved query, which is done with the starQuery() GraphQL mutation.

API Stability Long-Term

Syntax

graphql
starQuery(
      input: AddStarToQueryInput!
   ): BooleanResultType!

For the input, you'll have to give the name of the repository or view, then the unique identifier of the saved query. Click on the Show Query link below for example of how to get that identifier. See the Input Parameters section for details.

For the results, you'll receive confirmation if successful. See the Returned Values section.

Hide Query Example

Show Saved Queries Query

Example

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

Input Parameters

For the input, you'll only have to give the name of the search domain (i.e., the repository or view), and the unique identifier of the saved query you want to mark with a star. Click on the Show Query link in the Syntax section above for an example of how to get that identifier.

Table: AddStarToQueryInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 17, 2024
savedQueryIdstringyes Long-TermThe unique identifier for the saved search query.
searchDomainNamestringyes Long-TermThe name of the search domain associated with the saved query.

Returned Values

For the results, the only returned value indicates whether the mutation was successful or not. The table below describes this:

Table: BooleanResultType Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 24, 2024
resultbooleanyes Long-TermWhether the mutation was performed successfully.