Summary

The entitiesLabels() GraphQL query is used to get the labels associated with a specified type of asset — those that are available to the user running the query. It will return a maximum of one-thousand distinct labels.

Stability Level Short-Term

Syntax

graphql
entitiesLabels(
       input: EntitiesLabelsInputType!
    ) LabelsResult!

For the input, using the special datatype, you'll have to enter the type of asset (e.g., Dashboard, Action) for which you want to get labels.

For the results, you can get the total number of labels and the labels themselves — which is the point of using this query.

Example

Raw
graphql
query {
  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" : "query {
  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" : "query {
  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" : "query { ^
  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" : "query {
  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 = "query {
  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" : "query {
  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" : "query {
  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"
    }
  }
}

Input Parameters

The input datatype is used to specify the type of asset for which you want a list of labels. The parameters for this datatype are listed and described in this table:

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.

The datatype above uses another datatype for an enumerated list of entity types. For your convenience, the table for that sub-datatype is included here:

Table: EntitySearchEntityType

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
Action   Short-TermIndicates the entity type on which to search are actions.
Dashboard   Short-TermUsed to indicate the entity type on which to search are a dashboards.
File   Short-TermIndicates the entity type on which to search are a files.
Interaction   Short-TermSet to search entities for interactions.
Parser   Short-TermSet to search entities for parsers.
SavedQuery   Short-TermSet to search entities for saved queries.

Returned Values

For results, you can request the labels for the asset type given and you can get a count of the number of labels found for the asset type.

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.