querySearchDomains()

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 Searching Data documentation page.

Syntax

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

graphql

querySearchDomains(
     searchFilter: string
     typeFilter: SearchDomainTypes!
     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:

Show:

graphql

query {
  querySearchDomains(
     searchFilter:"localhost", 
     typeFilter: All, 
     sortBy: Name, orderBy: DESC )
  { results {
      id, name, reposExcludedInSearchLimit, 
      users { id, username, displayName },
      totalResults }
}

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

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

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 } ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

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

#! /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)

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 and Returned Datatypes

The given datatype SearchDomainTypes is an enumerated list: All, Views, or repository(). The Searchdomain__SortBy is also an enumerated list of choices: Name, Volume, DeletedAt or LimitName.

The returned datatype SearchDomainSearchResultSet has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SearchDomainSearchResultSet

Parameter	Type	Required	Stability	Description
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-Term`	The paginated results set. See `SearchDomain`.
`totalResults`	integer	yes	`Long-Term`	The total number of matching results.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes