childOrganizations()

API Stability	`Preview`

The childOrganizations() GraphQL query is used to get a list of linked child organizations. This is not supported when using organizations in single mode. This query field is a preview and subject to changes.

Syntax

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

graphql

childOrganizations(
     search: string, skip: integer, limit: integer,
     orderBy: OrderBy, sortBy: OrganizationsLinks__SortBy
   ): ChildOrganizationsResultSet!

For the input, there are several parameters, with only a couple simple special datatypes. The OrderBy is replaced with either ASC or DESC. OrganizationsLinks__SortBy is Cid, OrgId, or Name.

The return datatype, ChildOrganizationsResultSet represents a couple parameters, which are described in the next section.

Below is an example of how you might use this query:

Show:

graphql

query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	childOrganizations(skip: 0, limit: 10) ^
  {totalResults, results { ^
    id, name, searchDomains { ^
      id ^
    }, stats {userCount, dataVolume} ^
  }} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}'
    "$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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}';
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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}'''

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 {
	childOrganizations(skip: 0, limit: 10)
  {totalResults, results {
    id, name, searchDomains {
      id
    }, stats {userCount, dataVolume}
  }}
}"
}
);


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

For the input's special datatype, the values are given within curly-brackets. As for the returned results, a list of requests is entered in a comma-separated list, also within curly-brackets — and again for sub-selections.

Returned Datatype

For ChildOrganizationsResultSet, there are a couple possible values returned, which are listed below. One of them leads to more sub-choices.

Table: ChildOrganizationsResultSet

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: Sep 24, 2024
`results`	[`Organization`]	yes	`Preview`	The paginated result set. See `Organization`.
`totalResults`	integer	yes	`Preview`	The total number of matching results.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes