Stability Level Preview
API Stability Preview

The segment() GraphQL query will do fetch information about a specific segment. This query is not a quick lookup and should be used only for troubleshooting or to help with data recovery. It requires ManageCluster permission.

Syntax

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

graphql
segment(
     id: string!
   ): Segment

Below is an example using this query field:

Raw
graphql
query{
  segment(
    id: "123abc"
  )
  {repository {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{
  segment(
    id: \"123abc\"
  )
  {repository {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{
  segment(
    id: \"123abc\"
  )
  {repository {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{ ^
  segment( ^
    id: \"123abc\" ^
  ) ^
  {repository {id, name} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query{
  segment(
    id: \"123abc\"
  )
  {repository {id, name} }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query{
  segment(
    id: \"123abc\"
  )
  {repository {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{
  segment(
    id: \"123abc\"
  )
  {repository {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{
  segment(
    id: \"123abc\"
  )
  {repository {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": {
    "segment": {
      repository{
        "id": "123abc",
        "name": "humio"
      }
    }
  }
}

Returned Datatype

For Segment, there are a few parameters. They're listed here along with descriptions ofparametereach:

Table: Segment

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: Apr 15, 2025
datasourceDatasourceyes PreviewThis is the datasource. See Datasource.
deletedAtlong  PreviewWhen the segment was deleted.
endlongyes PreviewWhen the segment ended.
idstringyes PreviewThe unique identifier of the segment.
organizationOrganizationyes PreviewThe organization for the segment. See Organization.
repositoryRepositoryyes PreviewThe repository for the segment. See Repository.
startlongyes PreviewWhen the segment started.