The Alert datatype
includes various settings.
Table: Alert
| 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 28, 2025 | |||||
actions | string | yes | Long-Term | List of identifiers for actions to fire on query result. | |
actionsV2 | [Action] | yes | Long-Term | List of unique identifiers for actions to fire on query result. See Action. | |
allowedActions | [AssetAction] | yes | Preview | List of allowed actions. The is a preview; it may be changed. See AssetAction. | |
description | string | Long-Term | Description of alert. | ||
displayName | string | yes | Long-Term | Name of the alert. | |
enabled | boolean | yes | Long-Term | Flag indicating whether the alert is enabled. | |
id | string | yes | Long-Term | The identifier of the alert. | |
isStarred | boolean | yes | Long-Term | Whether the calling user has starred the alert. This has been deprecated and is no longer in use and has no effect. It will be removed in version 1.213. | |
labels | [string] | yes | Long-Term | Labels attached to the alert. | |
lastError | string | Long-Term | Last error encountered while running the alert. | ||
lastWarnings | [string] | yes | Long-Term | Last warnings encountered while running the alert. | |
Name | string | yes | Long-Term | The name of the alert. | |
package | PackageInstallation | Long-Term | A package installation. See PackageInstallation. | ||
packageId | VersionedPackageSpecifier | Long-Term | The unique identifier of the package installed, if one was used. VersionedPackageSpecifier is a scalar. | ||
queryOwnership | QueryOwnership | yes | Long-Term | Ownership of the query run by the alert. See QueryOwnership. | |
queryStart | string | yes | Long-Term | Start of the relative time interval for the query. | |
queryString | string | yes | Long-Term | LogScale query to execute. | |
resource | string | yes | Short-Term | The resource identifier for the alert. | |
runAsUser | User | Long-Term | Identifier of user by which the alert is run. See User. | ||
throttleField | string | Long-Term | Field on which to throttle alert. | ||
throttleTimeMillis | long | yes | Long-Term | Throttle time in milliseconds. | |
timeOfLastTrigger | long | Long-Term | UNIX timestamp for when the alert was last triggered. | ||
yamlTemplate | string | yes | Long-Term | A YAML formatted string that describes the alert. | |