Stability Level Preview
API Stability 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.

Syntax

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

graphql
alertFieldValues(
     input: AlertFieldValuesInput!
   ): AlertFieldValues!

For the input, there's only one required parameter. It has a special datatype, which is described the next section. The return datatype, AlertFieldValues is described in the Returned Datatypes section. Below is an example using this query field:

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

Notice that for the AlertFieldValuesInput input, it requires putting the parameter viewName and the name of the repository in curly-brackets. For AlertFieldValues, a simple list of fields requested is all that's needed.

Given Datatype

For AlertFieldValuesInput, there is only one parameter. 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

For AlertFieldValues, there are a few parameters. They're listed here along with descriptions 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.