Overview

Get information regarding your alert events - instances of alerts being triggered.

Learn more about alert events and incidents in our documentation.

Authentication and permissions

To use the Alert events service API you need to create a personal or team API key. It's recommended to use permission presets, as they are automatically updated with all relevant permissions. Alternatively, you can manually add the following individual permissions.

Presets	Permission	Description
Alerts	`alerts:ReadConfig`	Grants access to read alerts

Common error response codes

Status Code	Description
`400 Bad Request`	Response code 400
`401 Unauthorized`	Response code 401
`500 Internal Server Error`	Response code 500

Constants

FilterMatcher

Value
`FILTER_MATCHER_UNSPECIFIED`
`FILTER_MATCHER_EQUALS`
`FILTER_MATCHER_NOT_EQUALS`

FilterValuesOperator

Value
`FILTER_VALUES_OPERATOR_UNSPECIFIED`
`FILTER_VALUES_OPERATOR_OR`
`FILTER_VALUES_OPERATOR_AND`

AlertDefType

Value
`ALERT_DEF_TYPE_LOGS_IMMEDIATE_OR_UNSPECIFIED`
`ALERT_DEF_TYPE_LOGS_THRESHOLD`
`ALERT_DEF_TYPE_LOGS_ANOMALY`
`ALERT_DEF_TYPE_LOGS_RATIO_THRESHOLD`
`ALERT_DEF_TYPE_LOGS_NEW_VALUE`
`ALERT_DEF_TYPE_LOGS_UNIQUE_COUNT`
`ALERT_DEF_TYPE_LOGS_TIME_RELATIVE_THRESHOLD`
`ALERT_DEF_TYPE_METRIC_THRESHOLD`
`ALERT_DEF_TYPE_METRIC_ANOMALY`
`ALERT_DEF_TYPE_TRACING_IMMEDIATE`
`ALERT_DEF_TYPE_TRACING_THRESHOLD`
`ALERT_DEF_TYPE_FLOW`
`ALERT_DEF_TYPE_SLO_THRESHOLD`

DayOfWeek

Value
`DAY_OF_WEEK_MONDAY_OR_UNSPECIFIED`
`DAY_OF_WEEK_TUESDAY`
`DAY_OF_WEEK_WEDNESDAY`
`DAY_OF_WEEK_THURSDAY`
`DAY_OF_WEEK_FRIDAY`
`DAY_OF_WEEK_SATURDAY`
`DAY_OF_WEEK_SUNDAY`

NotifyOn

Value
`NOTIFY_ON_TRIGGERED_ONLY_UNSPECIFIED`
`NOTIFY_ON_TRIGGERED_AND_RESOLVED`

DurationUnit

Value
`DURATION_UNIT_UNSPECIFIED`
`DURATION_UNIT_HOURS`

BooleanOperator

Value
`BOOLEAN_OPERATOR_AND_UNSPECIFIED`
`BOOLEAN_OPERATOR_OR`

OrderByDirection

Value
`ORDER_BY_DIRECTION_ASC_OR_UNSPECIFIED`
`ORDER_BY_DIRECTION_DESC`

OrderByFields

Value
`ORDER_BY_FIELDS_UNSPECIFIED`
`ORDER_BY_FIELDS_NAME`
`ORDER_BY_FIELDS_ID`
`ORDER_BY_FIELDS_SEVERITY`
`ORDER_BY_FIELDS_CREATED_TIME`
`ORDER_BY_FIELDS_UPDATED_TIME`
`ORDER_BY_FIELDS_LAST_TRIGGERED`

AlertDefPriority

Value
`ALERT_DEF_PRIORITY_P5_OR_UNSPECIFIED`
`ALERT_DEF_PRIORITY_P4`
`ALERT_DEF_PRIORITY_P3`
`ALERT_DEF_PRIORITY_P2`
`ALERT_DEF_PRIORITY_P1`

AutoRetireTimeframe

Value
`AUTO_RETIRE_TIMEFRAME_NEVER_OR_UNSPECIFIED`
`AUTO_RETIRE_TIMEFRAME_MINUTES_5`
`AUTO_RETIRE_TIMEFRAME_MINUTES_10`
`AUTO_RETIRE_TIMEFRAME_HOUR_1`
`AUTO_RETIRE_TIMEFRAME_HOURS_2`
`AUTO_RETIRE_TIMEFRAME_HOURS_6`
`AUTO_RETIRE_TIMEFRAME_HOURS_12`
`AUTO_RETIRE_TIMEFRAME_HOURS_24`

TracingFilterOperationType

Value
`TRACING_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED`
`TRACING_FILTER_OPERATION_TYPE_INCLUDES`
`TRACING_FILTER_OPERATION_TYPE_ENDS_WITH`
`TRACING_FILTER_OPERATION_TYPE_STARTS_WITH`
`TRACING_FILTER_OPERATION_TYPE_IS_NOT`

TracingTimeWindowValue

Value
`TRACING_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED`
`TRACING_TIME_WINDOW_VALUE_MINUTES_10`
`TRACING_TIME_WINDOW_VALUE_MINUTES_15`
`TRACING_TIME_WINDOW_VALUE_MINUTES_20`
`TRACING_TIME_WINDOW_VALUE_MINUTES_30`
`TRACING_TIME_WINDOW_VALUE_HOUR_1`
`TRACING_TIME_WINDOW_VALUE_HOURS_2`
`TRACING_TIME_WINDOW_VALUE_HOURS_4`
`TRACING_TIME_WINDOW_VALUE_HOURS_6`
`TRACING_TIME_WINDOW_VALUE_HOURS_12`
`TRACING_TIME_WINDOW_VALUE_HOURS_24`
`TRACING_TIME_WINDOW_VALUE_HOURS_36`

TracingThresholdConditionType

Value
`TRACING_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED`

LogsAnomalyConditionType

Value
`LOGS_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED`

LogsUniqueValueTimeWindowValue

Value
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTE_1_OR_UNSPECIFIED`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_5`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_10`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_15`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_20`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_MINUTES_30`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_1`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_2`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_4`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_6`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_12`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_24`
`LOGS_UNIQUE_VALUE_TIME_WINDOW_VALUE_HOURS_36`

LogsRatioGroupByFor

Value
`LOGS_RATIO_GROUP_BY_FOR_BOTH_OR_UNSPECIFIED`
`LOGS_RATIO_GROUP_BY_FOR_NUMERATOR_ONLY`
`LOGS_RATIO_GROUP_BY_FOR_DENUMERATOR_ONLY`

LogsRatioTimeWindowValue

Value
`LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED`
`LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_10`
`LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_15`
`LOGS_RATIO_TIME_WINDOW_VALUE_MINUTES_30`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOUR_1`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_2`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_4`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_6`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_12`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_24`
`LOGS_RATIO_TIME_WINDOW_VALUE_HOURS_36`

LogsRatioConditionType

Value
`LOGS_RATIO_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED`
`LOGS_RATIO_CONDITION_TYPE_LESS_THAN`

LogsTimeRelativeConditionType

Value
`LOGS_TIME_RELATIVE_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED`
`LOGS_TIME_RELATIVE_CONDITION_TYPE_LESS_THAN`

LogsTimeRelativeComparedTo

Value
`LOGS_TIME_RELATIVE_COMPARED_TO_PREVIOUS_HOUR_OR_UNSPECIFIED`
`LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_YESTERDAY`
`LOGS_TIME_RELATIVE_COMPARED_TO_SAME_HOUR_LAST_WEEK`
`LOGS_TIME_RELATIVE_COMPARED_TO_YESTERDAY`
`LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_WEEK`
`LOGS_TIME_RELATIVE_COMPARED_TO_SAME_DAY_LAST_MONTH`

LogsTimeWindowValue

Value
`LOGS_TIME_WINDOW_VALUE_MINUTES_5_OR_UNSPECIFIED`
`LOGS_TIME_WINDOW_VALUE_MINUTES_10`
`LOGS_TIME_WINDOW_VALUE_MINUTES_20`
`LOGS_TIME_WINDOW_VALUE_MINUTES_15`
`LOGS_TIME_WINDOW_VALUE_MINUTES_30`
`LOGS_TIME_WINDOW_VALUE_HOUR_1`
`LOGS_TIME_WINDOW_VALUE_HOURS_2`
`LOGS_TIME_WINDOW_VALUE_HOURS_4`
`LOGS_TIME_WINDOW_VALUE_HOURS_6`
`LOGS_TIME_WINDOW_VALUE_HOURS_12`
`LOGS_TIME_WINDOW_VALUE_HOURS_24`
`LOGS_TIME_WINDOW_VALUE_HOURS_36`

LogFilterOperationType

Value
`LOG_FILTER_OPERATION_TYPE_IS_OR_UNSPECIFIED`
`LOG_FILTER_OPERATION_TYPE_INCLUDES`
`LOG_FILTER_OPERATION_TYPE_ENDS_WITH`
`LOG_FILTER_OPERATION_TYPE_STARTS_WITH`

LogSeverity

Value
`LOG_SEVERITY_VERBOSE_UNSPECIFIED`
`LOG_SEVERITY_DEBUG`
`LOG_SEVERITY_INFO`
`LOG_SEVERITY_WARNING`
`LOG_SEVERITY_ERROR`
`LOG_SEVERITY_CRITICAL`

LogsThresholdConditionType

Value
`LOGS_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED`
`LOGS_THRESHOLD_CONDITION_TYPE_LESS_THAN`

LogsNewValueTimeWindowValue

Value
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_12_OR_UNSPECIFIED`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_24`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_48`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_HOURS_72`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_WEEK_1`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTH_1`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_2`
`LOGS_NEW_VALUE_TIME_WINDOW_VALUE_MONTHS_3`

ActivityAnalysisStatus

Value
`ACTIVITY_ANALYSIS_STATUS_ACTIVATE_OR_UNSPECIFIED`
`ACTIVITY_ANALYSIS_STATUS_MUTE`

MetricAnomalyConditionType

Value
`METRIC_ANOMALY_CONDITION_TYPE_MORE_THAN_USUAL_OR_UNSPECIFIED`
`METRIC_ANOMALY_CONDITION_TYPE_LESS_THAN_USUAL`

MetricTimeWindowValue

Value
`METRIC_TIME_WINDOW_VALUE_MINUTES_1_OR_UNSPECIFIED`
`METRIC_TIME_WINDOW_VALUE_MINUTES_5`
`METRIC_TIME_WINDOW_VALUE_MINUTES_10`
`METRIC_TIME_WINDOW_VALUE_MINUTES_15`
`METRIC_TIME_WINDOW_VALUE_MINUTES_20`
`METRIC_TIME_WINDOW_VALUE_MINUTES_30`
`METRIC_TIME_WINDOW_VALUE_HOUR_1`
`METRIC_TIME_WINDOW_VALUE_HOURS_2`
`METRIC_TIME_WINDOW_VALUE_HOURS_4`
`METRIC_TIME_WINDOW_VALUE_HOURS_6`
`METRIC_TIME_WINDOW_VALUE_HOURS_12`
`METRIC_TIME_WINDOW_VALUE_HOURS_24`
`METRIC_TIME_WINDOW_VALUE_HOURS_36`

MetricThresholdConditionType

Value
`METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_UNSPECIFIED`
`METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN`
`METRIC_THRESHOLD_CONDITION_TYPE_MORE_THAN_OR_EQUALS`
`METRIC_THRESHOLD_CONDITION_TYPE_LESS_THAN_OR_EQUALS`

NextOp

Value
`NEXT_OP_AND_OR_UNSPECIFIED`
`NEXT_OP_OR`

AlertsOp

Value
`ALERTS_OP_AND_OR_UNSPECIFIED`
`ALERTS_OP_OR`

TimeframeType

Value
`TIMEFRAME_TYPE_UNSPECIFIED`
`TIMEFRAME_TYPE_UP_TO`

AlertStatus

Value
`ALERT_STATUS_RESOLVED_OR_UNSPECIFIED`
`ALERT_STATUS_TRIGGERED`

OrderByAlertEventFields

Value
`ORDER_BY_ALERT_EVENT_FIELDS_UNSPECIFIED`
`ORDER_BY_ALERT_EVENT_FIELDS_TIMESTAMP`

OrderByAlertEventDirection

Value
`ORDER_BY_ALERT_EVENT_DIRECTION_UNSPECIFIED`
`ORDER_BY_ALERT_EVENT_DIRECTION_ASC`
`ORDER_BY_ALERT_EVENT_DIRECTION_DESC`

SpecialRatioValues

Value
`SPECIAL_RATIO_VALUES_INFINITY_OR_UNSPECIFIED`

Authentication and permissions​

Common error response codes​

Constants​

Authentication and permissions

Common error response codes

Constants