API Stability Short-Term

The searchLogCollectorGroups() GraphQL query will search log collector configurations.

Syntax

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

graphql
searchLogCollectorGroups(
      searchFilter: string,
      sortBy: FleetGroups__SortBy, 
      orderBy: OrderBy,
      skip: integer, 
      limit: integer, 
   ): SearchLogCollectorGroupsResultSet!

For the input, there are several parameters. Some have default values: skip is 0; and limit is 50. There are defaults for the special datatypes. They're described in the Given Datatypes section below.

Below is an example using this query field:

Raw
graphql
query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}
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 {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
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 {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
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 { ^
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC) ^
     { totalResults,  ^
       results{id, name, collectorCount} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}'
    "$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 {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}";
$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 {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}'''

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 {
  searchLogCollectorGroups(sortBy: Name, orderBy: ASC)
     { totalResults, 
       results{id, name, collectorCount} }
}"
}
);


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();

Given Datatype

For FleetGroups__SortBy and OrderBy there are a few parameters. They're listed in the two tables here:

Table: FleetGroups__SortBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 3, 2025
Collectors   Short-TermSort by Fleet groups by collectors.
Filter   Short-TermSort Fleet groups by filter.
Name  ✓Short-TermSort the groups by name.
WantedVersion   Short-TermUse this to sort by version of LogScale.

Table: OrderBy

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 10, 2025
ASC  ✓Long-TermOrder results in ascending order (e.g., 0 to 9, A to Z).
DESC   Long-TermOrder results in descending order (e.g., 9 to 0, Z to A).

Returned Datatype

For SearchLogCollectorGroupsResultSet, there are a couple of parameters. They're listed here:

Table: SearchLogCollectorGroupsResultSet

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 3, 2024
results[LogCollectorGroup]yes Short-TermThe paginated result set. See LogCollectorGroup.
totalResultsintegeryes Short-TermThe total number of matching results.