API Stability Long-Term

The querySearchDomains() GraphQL query is used for query search domains with an organization filter.

For more information on searching repositories and views, see the Search Data documentation page.

Syntax

Below is the syntax for the querySearchDomains() query field:

graphql
querySearchDomains(
     searchFilter: string,
     typeFilter: SearchDomainTypes!,
     deleted: boolean, 
     includeHidden: boolean,
     sortBy: Searchdomain__SortBy!,
     orderBy: OrderBy,
     limitName: string,
     skip: integer,
     limit: integer,
   ): SearchDomainSearchResultSet!

This query field has several inputs, but not all required — as indicated by the exclamation marks. The given and returned datatypes are described together in the next section. Below is an example of how this query field might be used:

Raw
graphql
query {
  querySearchDomains(
     searchFilter:"localhost", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}
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 {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}"
}
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 {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}"
}
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 { ^
  querySearchDomains( ^
     searchFilter:\"localhost\",  ^
     typeFilter: All,  ^
     sortBy: Name, orderBy: DESC ) ^
  { results { ^
      id, name, reposExcludedInSearchLimit,  ^
      users { id, username, displayName }, ^
      totalResults } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}"
}'
    "$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 {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}";
$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 {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}"
}'''

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 {
  querySearchDomains(
     searchFilter:\"localhost\", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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();

Given Datatypes

The enumerated datatype SearchDomainTypes has a few choices. Below is a list of them along with a description of each:

Table: SearchDomainTypes

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2025
All   Long-TermDon't limit searches to a specific type of search domain.
Repository   Long-TermLimit searches to repositories.
Views   Long-TermSearch only views and not repositories.

The enumerated datatype Searchdomain__SortBy also has a few choices. Below is a list of them along with a description of each:

Table: Searchdomain__SortBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Jun 24, 2025
DeletedAt   Long-TermSort based on when deleted.
LimitName   Long-TermSort based on limit name.
Name   Long-TermSort based on name of search domain.
Volume   Long-TermSort based on volume.

Returned Datatypes

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

Table: SearchDomainSearchResultSet

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
results[SearchDomain]yes Long-TermThe paginated results set. See SearchDomain.
totalResultsintegeryes Long-TermThe total number of matching results.