alertFieldValues()

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 Results Datatypes section. Below is an example using this query field:

Show:

graphql

query {
	alertFieldValues(input:{viewName: "testeroo"} )
  {actionNames, labels}
}

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

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

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} ^
}" ^
} '

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

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
	alertFieldValues(input:{viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}';
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 {
	alertFieldValues(input:{viewName: \"testeroo\"} )
  {actionNames, labels}
}"
}'''

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


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

Show:

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

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 17, 2024
`viewName`	`RepoOrViewName`	yes	`Preview`	The 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

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

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes