starQuery()

API Stability	`Long-Term`

The starQuery() GraphQL mutation is used to star a saved query in user settings in LogScale.

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 starQuery() mutation field:

graphql

starQuery(
      input: AddStarToQueryInput!
   ): BooleanResultType!

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

Show:

graphql

mutation {
  starQuery( input:
    {
      searchDomainName: "humio",
      savedQueryId: "123abc"
    }
  )
  { result }
}

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: \"123abc\"
    }
  )
  { result }
}"
}
EOF

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: \"123abc\"
    }
  )
  { result }
}"
}
EOF

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: \"123abc\" ^
    } ^
  ) ^
  { result } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  starQuery( input:
    {
      searchDomainName: \"humio\",
      savedQueryId: \"123abc\"
    }
  )
  { result }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  starQuery( input:
    {
      searchDomainName: \"humio\",
      savedQueryId: \"123abc\"
    }
  )
  { result }
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  starQuery( input:
    {
      searchDomainName: \"humio\",
      savedQueryId: \"123abc\"
    }
  )
  { result }
}"
}'''

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  starQuery( input:
    {
      searchDomainName: \"humio\",
      savedQueryId: \"123abc\"
    }
  )
  { result }
}"
}
);


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();

Example Responses

Show:

json

{
  "data": {
    "starQuery": {
      "result": true
    }
  }
}

Given Datatypes

AddStarToQueryInput has two parameters. Below is a list of them along with a description of each:

Table: AddStarToQueryInput

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
`savedQueryId`	string	yes	`Long-Term`	The unique identifier for the saved search query.
`searchDomainName`	string	yes	`Long-Term`	The name of the search domain associated with the saved query.

Returned Datatypes

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

Table: BooleanResultType

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 24, 2024
`results`	boolean	yes	`Long-Term`	Whether the mutation was performed.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

starQuery()

Syntax

Given Datatypes

Returned Datatypes

Enter search term