Summary

The generateAggregateAlertFromTemplate() GraphQL query parses a YAML aggregate alert template and returns an unsaved UnsavedAggregateAlert object. Pass the result to createAggregateAlert() to save it.

API Stability Long-Term

Syntax

graphql
generateAggregateAlertFromTemplate(
      input: GenerateAggregateAlertFromTemplateInput!
   ): UnsavedAggregateAlert!

Provide the repository or view name as viewName and the YAML alert template as yamlTemplate. See Input Parameters and Returned Values for details.

Example

Raw
graphql
query {
  generateAggregateAlertFromTemplate(
    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 {
  generateAggregateAlertFromTemplate(
    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 {
  generateAggregateAlertFromTemplate(
    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 { ^
  generateAggregateAlertFromTemplate( ^
    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 {
  generateAggregateAlertFromTemplate(
    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 {
  generateAggregateAlertFromTemplate(
    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 {
  generateAggregateAlertFromTemplate(
    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 {
  generateAggregateAlertFromTemplate(
    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();

Input Parameters

Provide the repository or view name as viewName and the full YAML specification of the aggregate alert as yamlTemplate. Both fields are required.

Table: GenerateAggregateAlertFromTemplateInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
viewNameRepoOrViewNameyes Long-Term The name of the view of the aggregate alert. RepoOrViewName is a scalar.
yamlTemplateYAMLyes Long-Term The yaml specification of the aggregate alert. YAML is a scalar.

Returned Values

The result is a non-nullable UnsavedAggregateAlert object representing a preview of the alert. Key fields include name, queryString, actions (the list of actions to fire), labels, enabled, and throttleTimeSeconds. The available fields are listed here:

Table: UnsavedAggregateAlert Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results. 
Table last updated: Oct 14, 2026 
actionsActionyes Long-Term List of actions to fire on query result. See Action.
descriptionString  Long-Term Description of the aggregate alert.
enabledBooleanyes Long-Term Flag indicating whether the aggregate alert is enabled.
labelsStringyes Long-Term Labels attached to the aggregate alert.
nameStringyes Long-Term Name of the aggregate alert.
queryStringStringyes Long-Term The LogScale query to execute.
queryTimestampTypeQueryTimestampTypeyes Long-Term Timestamp type to use for a query. See QueryTimestampType.
searchIntervalSecondsLongyes Long-Term The search interval in seconds.
throttleFieldString  Deprecateddeprecated in 1.282The field on which to throttle. This can be set only if throttleTimeSeconds is set. Aggregate alerts now support multiple throttle fields. This field will be removed at the earliest in version 1.279. Use instead the throttleFields field.
throttleFieldsStringyes Long-Term The fields on which to throttle. This can be set only if throttleTimeSeconds is set.
throttleTimeSecondsLongyes Long-Term The throttle time in seconds.
triggerModeTriggerModeyes Long-Term The mode used for triggering the alert. See TriggerMode.