API Stability Long-Term

The updateQueryPrefix() GraphQL mutation is used to update a query prefix for a group in a view in LogScale.

There is some mention of query prefixes on the Query Monitor documentation page that you may find helpful.

Syntax

graphql
updateQueryPrefix(
      input: UpdateQueryPrefixInput!
   ): UpdateQueryPrefixMutation!

Example

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

Raw
graphql
mutation {
  updateQueryPrefix( input:
    { queryPrefix: "sales_",
      viewId: "abc123",
      groupId: "def456" }
  )
  { group { id } }
}
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 {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}"
}
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 {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}"
}
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 { ^
  updateQueryPrefix( input: ^
    { queryPrefix: \"sales_\", ^
      viewId: \"abc123\", ^
      groupId: \"def456\" } ^
  ) ^
  { group { id } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}"
}'
    "$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 {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}";
$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 {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}"
}'''

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 {
  updateQueryPrefix( input:
    { queryPrefix: \"sales_\",
      viewId: \"abc123\",
      groupId: \"def456\" }
  )
  { group { id } }
}"
}
);


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": {
    "updateQueryPrefix": {
      "group": {
        "id": "def456"
      }
    }
  }
}

Given Datatype

For the input datatype, you'll have to give the unique identifiers of the view and the group, then the query prefix to use with them. See the table below for details:

Table: UpdateQueryPrefixInput

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 23, 2024
groupIdstringyes Long-TermThe unique identifier of the group associated with the query.
queryPrefixstringyes Long-TermThe query prefix to update.
viewIdstringyes Long-TermThe unique identifier of the view associated with the query.

Returned Datatype

For the return datatype, through sub-parameters, you can get information on the group, such as how many users, a list of them, and which assets they can access. You can also get a list of roles and what they entail. Since this mutation affects the queryPrefixes parameter, that may be of interest to you. The table below contains a link to another table with the sub-parameters:

Table: UpdateQueryPrefixMutation

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 4, 2024
groupGroupyes Long-TermThe group for which to update the query prefix. See Group.