FilterAlert is a
datatype for a filter alert.
Table: FilterAlert
| Parameter | Type | Required | Default | 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: Mar 26, 2025 | |||||
actions | [Action] | yes | Long-Term | List of unique identifiers for actions to fire on query result. See Action. | |
allowedActions | [AssetAction] | yes | Preview | List of actions allowed on which to filter query results. See AssetAction. | |
description | string | Long-Term | Description of the filter alert. | ||
enabled | boolean | yes | Long-Term | Whether the filter alert is enabled. | |
id | string | yes | Long-Term | The unique identifier of the filter alert. | |
labels | [string] | yes | Long-Term | Labels attached to the filter alert. | |
lastError | string | Long-Term | Last error encountered while running the filter alert. | ||
lastErrorTime | long | Long-Term | Unix timestamp for last error. | ||
lastSuccessfulPoll | long | Long-Term | Unix timestamp for last successful poll of the filter alert query. If this is not quite recent, then the alert might be having problems. | ||
lastTriggered | long | Long-Term | Unix timestamp for last execution of trigger. | ||
lastWarnings | [string] | yes | Long-Term | Last warnings encountered while running the filter alert. | |
modifiedInfo | modifiedInfo | Long-Term | User or token used to modify the asset. See ModifiedInfo. This is a preview and subject to change. | ||
Name | string | yes | Long-Term | The name of the filter alert. | |
package | PackageInstallation | Long-Term | The package of which the alert was installed. See PackageInstallation. | ||
packageId | VersionedPackageSpecifier | Long-Term | The unique identifier of the package of which the alert was installed. VersionedPackageSpecifier is a scalar. | ||
queryOwnership | queryOwnership | yes | Long-Term | Ownership of the query run by this alert. See QueryOwnership. | |
queryString | string | yes | Long-Term | The LogScale query to execute. | |
resource | string | yes | Short-Term | The resource identifier for this filter alert. | |
throttleField | string | Long-Term | A field to throttle on. Can only be set if throttleTimeSeconds is set. | ||
throttleTimeSeconds | long | Long-Term | The throttle time in seconds. | ||
yamlTemplate | yaml | yes | Long-Term | YAML specification of the filter alert. | |