FilterAlert is a datatype for a filter alert.

Table: FilterAlert

ParameterTypeRequiredDefaultDescription
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 25, 2024
actions[action]yes List of unique identifiers for actions to fire on query result. See Action.
allowedActions[AssetAction]yes List of actions allowed on which to filter query results. See AssetAction.
descriptionstring  Description of the filter alert.
enabledbooleanyes Whether the filter alert is enabled.
idstringyes The unique identifier of the filter alert.
labels[string]yes Labels attached to the filter alert.
lastErrorstring  Last error encountered while running the filter alert.
lastErrorTimelong  Unix timestamp for last error.
lastSuccessfulPolllong  Unix timestamp for last successful poll of the filter alert query. If this is not quite recent, then the alert might be having problems.
lastTriggeredlong  Unix timestamp for last execution of trigger.
lastWarnings[string]yes Last warnings encountered while running the filter alert.
modifiedInfomodifiedInfo  User or token used to modify the asset. See ModifiedInfo. This is a preview and subject to change.
namestringyes The name of the filter alert.
packagePackageInstallation  The package of which the alert was installed. See PackageInstallation.
packageIdVersionedPackageSpecifier  The unique identifier of the package of which the alert was installed. VersionedPackageSpecifier is a scalar.
queryOwnershipqueryOwnershipyes Ownership of the query run by this alert. See QueryOwnership.
queryStringstringyes The LogScale query to execute.
throttleFieldstring  A field to throttle on. Can only be set if throttleTimeSeconds is set.
throttleTimeSecondslong  The throttle time in seconds.
yamlTemplateyamlyes YAML specification of the filter alert.