API Stability Preview

The queryAssistance() GraphQL query is used to return query assistance for the given search, as well as the assistant version. This is a preview and subject to change.

Syntax

Below is the syntax for the queryAssistance() query field:

graphql
queryAssistance(
      search: string!, 
      remapFields: boolean!
   ): QueryAssistantResult!

For search, you would enter the search query for with which you want assistance. For remapFields, you would set to true to enable remapping of often used fields to their LogScale equivalents. The default for this is false.

The input calls for standard datatypes. For QueryAssistantResult, there is a special datatypes. See the Returned Datatypes section. Here's an example of how this query field might be used:

Raw
graphql
query {
  queryAssistance(search:"127.0.0.1", remapFields: false)
  {version, assistance{__typename} }
}
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 {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}"
}
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 {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}"
}
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 { ^
  queryAssistance(search:\"127.0.0.1\", remapFields: false) ^
  {version, assistance{__typename} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}"
}'
    "$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 {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}";
$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 {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}"
}'''

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 {
  queryAssistance(search:\"127.0.0.1\", remapFields: false)
  {version, assistance{__typename} }
}"
}
);


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": {
    "queryAssistance": {
      "version": "1.1-0e71eb90c9",
      "assistance": {
        "__typename": "QueryAssistantError"
      }
    }
  }
}

Returned Datatypes

For QueryAssistantResult, there are a couple of parameters and a sub-parameters. Below is a list of the parameters with links to the sub-parameter:

Table: QueryAssistantResult

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: Oct 2, 2024
assistanceQueryAssistantAssistanceyes PreviewThe query assistance for the given search. Can be either a successful or an error. See QueryAssistantAssistance.
versionstringyes PreviewThe assistant version.