searchDomainsPage()

Summary

The searchDomainsPage() GraphQL query returns a paged list of search domains and information on each.

API Stability Long-Term

Syntax

graphql

searchDomainsPage(
      search: String,
      includeHidden: Boolean,
      pageNumber: Int!,
      pageSize: Int!
   ): SearchDomainPage!

Provide text to search repository and view names, indicate whether to include hidden search domains, specify the number of results per page, and which page to return.

Returns a non-nullable SearchDomainPage object. See the Returned Values section for more.

Example

Raw

graphql

query {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}

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 {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}
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 {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}
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 { ^
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1) ^
  { pageInfo{totalNumberOfRows, total},  ^
    page { id, name } } ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}'
    "$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 {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}";
$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 {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}'''

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 {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}
);


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": {
    "searchDomainsPage": {
      "pageInfo": {
        "totalNumberOfRows": 9,
        "total": 1
      },
      "page": [
        {
          "id": "abc123",
          "name": "humio"
        },
        {
          "id": "def456",
          "name": "humio-audit"
        },
        {
          "id": "ghi789",
          "name": "humio-metrics"
        }
       ...  
      ]
    }
  }
}

Input Parameters

You may provide text on which to search repository and view names, indicate whether to include hidden search domains, as well as the number of results per page, and, based on that, which page to return.

Table: Input Parameters & Datatypes

Parameter	Type	Required	Description
This table contains all input parameters for this query.
includeHidden	Boolean		Whether to include hidden search domains in results.
pageNumber	Int	yes	Which page to return.
pageSize	Int	yes	The number of results returned per page.
search	String		Any text on which to search for repositories and views.

Returned Values

Returns a non-nullable SearchDomainPage object. The table below lists all fields:

Table: SearchDomainPage Datatype

Parameter	Type	Required	Stability	Description
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
page	SearchDomain	yes	`Long-Term`	The dashboards to be used for the dashboard page. See SearchDomain.
pageInfo	PageType	yes	`Long-Term`	Information about the search domain page (see PageType Table).

The SearchDomainPage type contains SearchDomain objects. For reference, the SearchDomain datatype table is included here:

Table: SearchDomain Interface Datatype

Parameter	Type	Required	Stability	Availability	Description
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
action	ViewAction):Boolean	yes	`Long-Term`		A saved action. See Action.
actionIds	String]):[Action	yes	`Long-Term`		The result will only include actions with the specified ids. Omit to find all actions.
aggregateAlerts	AggregateAlert	yes	`Long-Term`		A list of saved aggregate alerts. See AggregateAlert.
alert(id: String!)	Alert	yes	`Long-Term`		A saved alert. See Alert.
alerts	Alert	yes	`Long-Term`		Saved alerts. See Alert.
allowedViewActions	ViewAction	yes	`Long-Term`		Returns all actions the user is allowed to perform on the view. See ViewAction.
automaticSearch	Boolean	yes	`Long-Term`		Whether to execute automatically the default search query.
awsExternalId	String	yes	`Long-Term`		The AWS External ID used when assuming roles in AWS on behalf of this repository. Stability: Long-term
categories	String]):[PackageRegistrySearchResultItem	yes	`Long-Term`		Packages with any of these categories will be included.
dashboard(id: String!)	Dashboard	yes	`Long-Term`		The default or initial Dashboard to use. See Dashboard.
dashboards	Dashboard	yes	`Long-Term`		All dashboards available on the view. See Dashboard.
defaultQuery	SavedQuery		`Long-Term`		Stability: Long-term
deletedDate	Long		`Long-Term`		The point in time the search domain was marked for deletion.
description	String		`Long-Term`		A description of the search domain.
fieldName	String,	yes			Name of the field in the file to return entries from.
fieldsToInclude	String],	yes			Names of the fields to include in the result.
fileName	String,	yes			Name of the csv or json file to retrieve the field entries from.
files	File	yes	`Long-Term`		Files belonging to the search domain. See File.
filter	String,				Filter input to limit the returned packages
filterAlerts	FilterAlert	yes	`Long-Term`		Saved filter alerts. See FilterAlert.
gcpExternalId	String		`Long-Term`	added in 1.259	The value to set as the 'logscale-external-id' label on the GCS bucket. Stability: Long-term
gcsActionServiceAccountEmail	String		`Long-Term`	added in 1.259	The email of the GCP service account that LogScale uses to impersonate target service accounts for GCS actions. Stability: Long-term
groups	Group	yes	`Long-Term`		Groups with assigned roles. See Group.
hasPackageInstalled(packageId: VersionedPackageSpecifier!)	Boolean	yes	`Long-Term`		Whether there is an installed package. VersionedPackageSpecifier is a scalar.
id	String):ScheduledReport	yes	`Long-Term`		The unique identifier for the search domain.
installedPackages	PackageInstallation	yes	`Long-Term`		List packages installed on a specific view or repository. See PackageInstallation.
interactions	ViewInteraction	yes	`Long-Term`		All interactions defined on the view. See ViewInteraction.
isStarred	Boolean	yes	`Long-Term`		Whether the search domain is highlighted with a star.
limit	Int):PersistedAggregationResultSet	yes	`Preview`		The amount of results to return.
maxEntries	Int):[[DictionaryEntryType]	yes	`Long-Term`		Maximum number of values to retrieve from the file.
name	String):ScheduledSearch	yes	`Long-Term`		The name of the search domain. RepoOrViewName is a scalar.
orderBy	OrderBy,				Choose the order in which the results are returned.
packageId	VersionedPackageSpecifier):Package2	yes	`Long-Term`		The package id of the package to get.
packageVersions(packageId: UnversionedPackageSpecifier!)	RegistryPackageVersionInfo	yes	`Long-Term`		The available versions of a package. UnversionedPackageSpecifier is a scalar. See RegistryPackageVersionInfo.
permanentlyDeletedAt	Long		`Long-Term`		The point in time the search domain will not be restorable anymore.
permissionFilter	Permission,				Permission that the users must have on the search domain. Leave out to get users with any permission on the view
prefixFilter	String,				Text to filter values by prefix on.
recentQueriesV2	RecentQuery	yes	`Long-Term`		All recent queries for the search domain. See RecentQuery.
redirectQueryAssetLookupTo	SearchDomain		`Preview`		The redirected query asset lookup view used for asset resolution when set. Assets like saved queries and lookup files will be resolved from this view instead of the current view.
reposExcludedInSearchLimit	String	yes	`Long-Term`		Repositories not part of the search limitation.
resource	String	yes	`Short-Term`		The resource identifier for the search domain.
s3ActionArn	String		`Long-Term`		The ARN of the AWS IAM identity that will write to S3 for S3 actions. Stability: Long-term
savedQueries	SavedQuery	yes	`Long-Term`		The saved queries. See SavedQuery.
savedQuery(id: String!)	SavedQuery	yes	`Long-Term`		A saved query. See SavedQuery.
scheduledReports	ScheduledReport	yes	`Long-Term`		Saved scheduled reports. See ScheduledReport.
scheduledSearches	ScheduledSearch	yes	`Long-Term`		The scheduled searches to use with the search domain. See ScheduledSearch.
search	String,				Search for a user whose email or name matches this search string
searchLimitedMs	Long		`Long-Term`		Limit in milliseconds to which searches should are limited.
skip	Int,				The number of results to skip or the offset to use. For instance if implementing pagination, set skip = limit * (page - 1)
sortBy	PersistedAggregationSortBy,				The field by which to sort persisted aggregations. Defaults to Name.
starredFields	String	yes	`Long-Term`		All fields in the search domain to mark with a star.
tags	String	yes	`Long-Term`		All tags from all datasources.
users	User	yes	`Long-Term`		Users who have access to the search domain. See User.
valueFilters	FileFieldFilterType],	yes			The exact values that given fields should have for an entry to be part of the result.
viewerQueryPrefix	String	yes	`Long-Term`		The query prefix prepended to each search in this domain.

Versions of this Page

GraphQL Queries

GraphQL API

GraphQL Mutations

GraphQL Datatypes