Skip to main content

Alert definitions service overview

View and manage your alerts using alert definitions - data structures that contain the configuration required to create an alert. Learn more about alerts in our documentation.

Authentication and permissions

To use the Alert definitions 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.

Common error response codes

Protocol documentation

AlertDef

Represents An Existing or Created Alert Definition

AlertDefProperties

Represents The non generated alert definition properties (the ones that are set by the user)

AlertDefProperties.EntityLabelsEntry

AlertDefIncidentSettings

AlertDefNotificationGroup

AlertDefWebhooksSettings

IntegrationType

Recipients

NotifyOn

AlertDefPriority

ActivitySchedule

TimeOfDay

DayOfWeek

AlertDefType

ActivityAnalysis

ActivityAnalysisStatus

FlowStages

FlowStagesGroup

FlowStagesGroups

FlowStagesGroupsAlertDefs

FlowType

AlertsOp

NextOp

TimeframeType

LogsAnomalyConditionType

LabelFilterType

LabelFilters

LogsFilter

LogsSimpleFilter

LogFilterOperationType

LogSeverity

LogsTimeWindow

LogsTimeWindowValue

LogsAnomalyCondition

LogsAnomalyRule

LogsAnomalyType

LogsImmediateType

LogsNewValueCondition

LogsNewValueRule

LogsNewValueType

LogsRatioCondition

LogsRatioRules

LogsRatioThresholdType

LogsThresholdCondition

LogsThresholdRule

LogsThresholdType

LogsTimeRelativeCondition

LogsTimeRelativeRule

LogsTimeRelativeThresholdType

LogsUniqueCountCondition

LogsUniqueCountRule

LogsUniqueCountType

LogsNewValueTimeWindow

LogsNewValueTimeWindowValue

LogsRatioConditionType

LogsRatioGroupByFor

LogsRatioTimeWindow

LogsRatioTimeWindowValue

LogsThresholdConditionType

LogsTimeRelativeComparedTo

LogsTimeRelativeConditionType

LogsUniqueValueTimeWindow

LogsUniqueValueTimeWindowValue

MetricAnomalyConditionType

MetricTimeWindow

MetricTimeWindowValue

MetricFilter

MetricAnomalyCondition

MetricAnomalyRule

MetricAnomalyType

MetricThresholdCondition

MetricThresholdRule

MetricThresholdType

MetricThresholdConditionType

MetricMissingValues

AlertDefOverride

TracingFilter

TracingFilterType

TracingLabelFilters

TracingSimpleFilter

TracingSpanFieldsFilterType

TracingFilterOperationType

TracingThresholdConditionType

TracingTimeWindow

TracingTimeWindowValue

TracingImmediateType

TracingThresholdCondition

TracingThresholdRule

TracingThresholdType

UndetectedValuesManagement

AutoRetireTimeframe

AuditLogDescription

BatchGetAlertDefRequest

BatchGetAlertDefResponse

BatchGetAlertDefResponse.AlertDefsEntry

CreateAlertDefRequest

CreateAlertDefResponse

DeleteAlertDefRequest

DeleteAlertDefResponse

DownloadAlertsRequest

DownloadAlertsResponse

GetAlertDefRequest

GetAlertDefResponse

ListAlertDefsRequest

ListAlertDefsResponse

OrderBy

ReplaceAlertDefRequest

ReplaceAlertDefResponse

SetActiveRequest

SetActiveResponse

OrderByDirection

OrderByFields

File-level Extensions