Summary

The entitiesSearch() GraphQL query searches assets across LogScale views and repositories. It returns only the first page of results. The response includes a cursor that entitiesPage() uses to retrieve subsequent pages with the same parameters.

API Stability Short-Term

Syntax

graphql
entitiesSearch(
      input: EntitySearchInputType!
   ): SearchResult!

Provide the search criteria, entity type, and pagination size via input. The default search term is blank, which returns all entities of the specified type. The result includes the matching entities and a cursor for use with entitiesPage(). See Input Parameters and Returned Values for details.

Example

Raw
graphql
query {
  entitiesSearch(
    input: {searchTerm: "sales", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}
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 {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}"
}
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 {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}"
}
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 { ^
  entitiesSearch( ^
    input: {searchTerm: \"sales\",  ^
            entityTypes: [Dashboard],  ^
            pageSize: 5} ^
  ) { totalResults, cursor, ^
      hasPreviousPage, hasNextPage } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}"
}'
    "$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 {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}";
$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 {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}"
}'''

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 {
  entitiesSearch(
    input: {searchTerm: \"sales\", 
            entityTypes: [Dashboard], 
            pageSize: 5}
  ) { totalResults, cursor,
      hasPreviousPage, hasNextPage }
}"
}
);


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": {
    "entitiesSearch": {
      "totalResults": 15,
      "cursor": "eyJlbnRpdHlU..."
      "hasPreviousPage": false,
      "hasNextPage": true
    }
  },
  "extensions": {
    "preview": [
      {
        "name": "entitiesSearch",
        "reason": "[PREVIEW: Under development]"
      }
    ]
  }
}

The example requests dashboards with "sales" in their name, limited to five results per page. The response shows totalResults, pagination flags, and a truncated cursor value. Pass that cursor to entitiesPage() to retrieve additional pages.

Input Parameters

Specify a search term or a specific field on which to search. You can also indicate how results are sorted and other pagination parameters. The parameters are listed here:

Table: EntitySearchInputType Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
entityTypesEntitySearchEntityTypeyes Short-Term The types of entity. See EntitySearchEntityType .
fieldFiltersFieldFilterInputyes Short-Term The fields on which to filter. See FieldFilterInput.
pageSizeInt  Short-Term The number of records to return per page.
pathsStringyes Short-Term The paths to search.
searchTermString  Short-Term Text on which to search assets in views and repositories.
sortByEntitySearchSortInfoTypeyes Short-Term Enter name with a string for the field on which to sort. See EntitySearchSortInfoType.

Returned Values

The result provides the total matched count (totalResults), the list of entities for this page (data), a cursor for further pagination (cursor, nullable), and booleans indicating whether additional pages exist (hasNextPage, hasPreviousPage). The choices are listed here:

Table: SearchResult Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
cursorString  Short-Term The cursor useds for going to the next or previous page.
dataEntitySearchResultEntityyes Short-Term The results of the search. See EntitySearchResultEntity.
hasNextPageBooleanyes Short-Term Whether there is a next page. False indicates it's the last page.
hasPreviousPageBooleanyes Short-Term Whether there is a previous page. False indicates it's the first page.
totalResultsIntyes Short-Term The total number of results that matched the search query. Only pageSize elements will be returned.