Stability Level Preview

The alertFieldValues() GraphQL query will return a list of all actions, labels and packages used in an alert. This query field is a preview and subject to changes.

Related to this query field and alerts are several mutations: updateAlert() for updating a legacy alert; updateAggregateAlert() for updating an aggregate alert; and updateFilterAlert() for updating a filter alert.

You can access this information, albeit less precisely, through the UI: see the Manage Actions page in the main documentation.

Syntax

graphql
alertFieldValues(
     input: AlertFieldValuesInput!
   ): AlertFieldValues!

For the input, you would need to give the name of the view or repository related to the alert field values. For the results, you can request the action names and some other information. See the Returned Datatype section.

Example

The example below of how this query might be used:

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"
      ]
    }
  }
}

Given Datatype

The input datatype is used to provide the name of the view or repository for the alerts of which you want information. It's described in this table:

Table: AlertFieldValuesInput

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: Sep 17, 2024
viewNameRepoOrViewNameyes PreviewThe name of view for the alerts. RepoOrViewName is a scalar.

Returned Datatype

The returned datatype is used to return all actions, labels and packages used in an alert. Notice that the parameters for this datatype call for listing an array of string values — listed within double-quotes, separated by commas, and all within square-brackets. These parameters are shown here, along with a description of each:

Table: AlertFieldValues

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: Sep 23, 2024
actionNames[string]yes PreviewList of names of actions attached to alerts. Sorted lexicographically by action names.
labels[string]yes PreviewList of labels attached to alerts. Sorted lexicographically by label names.
unversionedPackageSpecifiers[string]yes PreviewA list of packages for installed alerts as non-versioned qualified package specifiers scope/packageName — sorted lexicographically.