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

Below is the syntax for the updateQueryPrefix() mutation field:

graphql
updateQueryPrefix(
      input: UpdateQueryPrefixInput!
   ): UpdateQueryPrefixMutation!

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/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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateQueryPrefix": {
      "group": {
        "id": "def456"
      }
    }
  }
}

Given Datatypes

For UpdateQueryPrefixInput, there are a few parameters. Below is a list of them along with a description of each:

Table: UpdateQueryPrefixInput

ParameterTypeRequiredDefaultStabilityDescription
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 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 Datatypes

The returned datatype UpdateQueryPrefixMutation has one parameter and several sub-parameters. Click on the link below to see a table containing the sub-parameters:

Table: UpdateQueryPrefixMutation

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