Stability Level Short-Term
API Stability Short-Term

The entitiesLabels() GraphQL mutation is used for the labels associated with specified assets available to the requester. Returns a maximum limit of 1000 distinct labels.

Syntax

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

graphql
entitiesLabels(
       input: EntitiesLabelsInputType!
    ): LabelsResult!

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

Raw
graphql
mutation {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}
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 {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}"
}
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 {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}"
}
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 { ^
  entitiesLabels( ^
    input: {  ^
       entityTypes: [File], ^
       paths: [] } ^
  ) { labels, totalCount } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}"
}'
    "$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 {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}";
$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 {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}"
}'''

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 {
  entitiesLabels(
    input: { 
       entityTypes: [File],
       paths: [] }
  ) { labels, totalCount }
}"
}
);


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": {
    "entitiesLabels": {
      "labels": {
          "admin"
      }
      "totalCount": "1"
    }
  }
}

Given Datatypes

For the EntitiesLabelsInputType given datatype, there are a couple parameters. Below is a list of them, along with a description of each.

Table: EntitiesLabelsInputType

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 30, 2025
entityTypes[EntitySearchEntityType]yes Short-TermThe entity types for the labels. See EntitySearchEntityType .
paths[string]  Short-TermThe paths related to the entities.

Returned Datatypes

For LabelsResult, there are also a couple parameters. Below is a list of them:

Table: LabelsResult

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 30, 2025
labels[string]yes Short-TermThe labels associated with the Entity Types given. Returns a maximum of 1000 distinct labels.
totalCountintegeryes Short-TermThe total number of distinct labels.