generateFilterAlertFromTemplate()

API Stability Long-Term

A yaml template can contain plenty of data, including the details for a filter alert. You can use the generateFilterAlertFromTemplate() query field to extract the data for creating a filter alert. You'll then need to use the createFilterAlert() mutation field to create one.

Syntax

graphql
generateFilterAlertFromTemplate(
     input: GenerateFilterAlertFromTemplateInput!
   ): UnsavedFilterAlert!

For the input, you'll have to give the view or repository name, and provide the yaml template from which you want to extract the filter alert. For the results, you can request whatever you need to create a new filter alert (e.g., the query string, any actions). See the Return Datatype section for more possibilities.

Example

Below is an example of how this query field might be used:

Raw
graphql
query {
  generateFilterAlertFromTemplate(
    input: {viewName: "company-http", 
            yamlTemplate: "favorite-yaml-template"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}
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 {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}"
}
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 {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}"
}
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 { ^
  generateFilterAlertFromTemplate( ^
    input: {viewName: \"company-http\",  ^
            yamlTemplate: \"favorite-yaml-template\"} ^
  ) { ^
    name,  ^
    description, ^
    throttleField, ^
    actions { ^
      id, name, isAllowedToRun ^
    }     ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}"
}'
    "$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 {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}";
$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 {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}"
}'''

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 {
  generateFilterAlertFromTemplate(
    input: {viewName: \"company-http\", 
            yamlTemplate: \"favorite-yaml-template\"}
  ) {
    name, 
    description,
    throttleField,
    actions {
      id, name, isAllowedToRun
    }    
  }
}"
}
);


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();

Given Datatype

For the given datatype, you'll need to specify the view or repository name and provide the yaml template from which you want to get the filter alert. The parameters for that are described in the table below:

Table: GenerateFilterAlertFromTemplateInput

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 18, 2024
viewNameRepoOrViewNameyes Long-TermThe name of the view of the filter alert. RepoOrViewName is a scalar.
yamlTemplateYAMLyes Long-TermThe yaml specification of the filter alert. YAML is a scalar.

Returned Datatype

For the results, you can request what you need to create a new filter alert. At a minimum, you'll need the query string. You might want to look at any actions contained in the template, although you might want to change them to your needs. Below is a list of your choices:

Table: UnsavedFilterAlert

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: Feb 10, 2026
actions[Action]yes Long-TermList of unique identifiers for actions to fire on query result. See Action.
descriptionstring  Long-TermThe description of the filter alert.
enabledbooleanyes Long-TermWhether the filter alert is enabled.
labels[string]yes Long-TermLabels attached to the filter alert.
namestringyes Long-TermThe name of the filter alert.
queryStringstringyes Long-TermThe LogScale query to execute.
throttleFieldstring  DeprecatedThe field on which to throttle. This can be set only if throttleTimeSeconds is set. Filter alerts now support multiple throttle fields. This field will be removed at the earliest in version 1.279. Use instead the throttleFields field.
throttleFields[string]  Long-TermThe fields on which to throttle. This can be set only if throttleTimeSeconds is set.
throttleTimeSecondslong  Long-TermThe throttle time in seconds.