Summary

The alertFieldValues() GraphQL query returns all action names, labels, and package specifiers used across alerts in a view or repository. Use this query to inspect which actions, labels, and packages are referenced by alerts before managing or updating them. All three returned lists are sorted lexicographically. This query field is a preview and subject to change.

API Stability Preview

Syntax

graphql
alertFieldValues(
      input: AlertFieldValuesInput!
   ): AlertFieldValues!

Provide the name of the view or repository containing the alerts you want to inspect. See Input Parameters for details.

Example

Raw
graphql
query {
	alertFieldValues(
	  input: {viewName: "testeroo"} )
  {actionNames, labels}
}
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 {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}
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 {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}
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 { ^
	alertFieldValues( ^
	  input: {viewName: \"testeroo\"} ) ^
  {actionNames, labels} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}'
    "$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 {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}";
$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 {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}'''

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 {
	alertFieldValues(
	  input: {viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}
);


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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "alertFieldValues": {
      "actionNames": [
        "email-admin"
      ],
      "labels": [
        "late"
      ]
    }
  }
}

The example above returns all action names, labels, and package specifiers for alerts in the specified view.

Input Parameters

Provide the name of the view or repository containing the alerts you want to inspect. The input parameter is described here:

Returned Values

The result contains three lexicographically sorted lists: the names of all actions attached to alerts (actionNames), the labels attached to alerts (labels), and unversioned package specifiers for installed alerts (unversionedPackageSpecifiers), in scope/packageName format. The available fields are listed here: