API Stability Long-Term

The setTagGroupings() GraphQL mutation is used to set current tag groupings for a repository.

Syntax

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

graphql
setTagGroupings(
      repositoryName: string!, 
      tagGroupings: [TagGroupingRuleInput]!
   ): [TagGroupingRule]!

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

Raw
graphql
mutation {
  setTagGroupings( 
    repositoryName: "humio",
  tagGroupings: [ { tagName: "stuff", groupCount: 3 } ]
  ) 
  { groupCount }
}
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 {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}"
}
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 {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}"
}
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 { ^
  setTagGroupings(  ^
    repositoryName: \"humio\", ^
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ] ^
  )  ^
  { groupCount } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}"
}'
    "$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 {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}";
$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 {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}"
}'''

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 {
  setTagGroupings( 
    repositoryName: \"humio\",
  tagGroupings: [ { tagName: \"stuff\", groupCount: 3 } ]
  ) 
  { groupCount }
}"
}
);


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": {
    "setTagGroupings": [
      {
        "groupCount": 3
      }
    ]
  }
}

Given Datatypes

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

Table: TagGroupingRuleInput

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 20, 2024
groupCountintegeryes Long-TermThe number of groups the tag will be split into.
tagNamestringyes Long-TermThe tag name to which the rule will apply.

Returned Datatypes

The returned datatype TagGroupingRule has a couple of parameters. Below is a list of them along with a description of each:

Table: TagGroupingRule

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 13, 2025
groupCountintegeryes Short-TermThe number of groups that tag values are distributed.
tagNamestringyes Short-TermThe name of the given tag into which values will be distributed.