The searchDomainsPage() GraphQL query is used for paged search domains. This field is not yet available. It's described here as a preview and is used for getting a new pagination pattern.

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

Syntax

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

graphql
searchDomainsPage(
     search: string
     pageNumber: integer!
     pageSize: integer!
   ): SearchDomainPage!

The input for this query field use standard datatypes. For the return datatype, there are several parameters. They're covered in the Returned Datatypes section. Here's an example of how you might use this query field:

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 $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  searchDomainsPage(includeHidden: true, pageSize: 10, pageNumber: 1)
  { pageInfo{totalNumberOfRows, total}, 
    page { id, name } }
}"
}';
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/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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "searchDomainsPage": {
      "pageInfo": {
        "totalNumberOfRows": 9,
        "total": 1
      },
      "page": [
        {
          "id": "aK9GKAsTnMXfRxT8Fpecx3fX",
          "name": "humio"
        },
        {
          "id": "myMtpg8UxGgEkBsYWTs3mOsD",
          "name": "humio-audit"
        },
        {
          "id": "N7t1bAn6xWMsWjVptueeNR16",
          "name": "humio-metrics"
        }
       ...  
      ]
    }
  }
}

Returned Datatypes

SearchDomainPage has several parameters. Below is a list of them along with description of each:

Table: SearchDomainPage

ParameterTypeRequiredDefaultDescription
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
page[SearchDomain]yes The dashboards to be used for the dashboard page. See SearchDomain.
pageInfoPageTypeyes Information about the search domain page (see PageType Table).