Skip to content

Latest commit

 

History

History
29 lines (26 loc) · 4.94 KB

AlertReport.md

File metadata and controls

29 lines (26 loc) · 4.94 KB

AlertReport

Properties

Name Type Description Notes
active_only bool true: only alerts that are still alerting (i.e. haven't yet cleared) will be displayed in the report false: active alerts and cleared alerts will both be displayed in the report [optional]
sorted_by str count host
chain str All alerts displayed in the report must have been routed to the Escalation Chains specified in this filter [optional]
anomaly str all yes
date_range str The Time Range configured for the report. Options include: Last 2 hours Last 24 hours
level str all error
timing str overlap start - Any alerts active during the specified dateRange will be displayed in the report if time=overlap. If time=start, only alerts that started during the specified dateRange will be displayed in the report
columns list[DynamicColumn] The columns that will be displayed in the report. You should specify the columns in the order in which you'd like them to be displayed. All column names need to be included in this object, but each column should have an associated isHidden field that indicates whether it is displayed or not. NOTE that if summaryOnly is set to true you can only include these columns: Alerts, Group, Device, Instance, Datapoint. If summaryOnly is set to false you can include these columns: Severity, Group, Device, Instance, Datapoint, Thresholds, Value, Began, End, Rule, Chain, Acked, Acked By, Acked On, Notes, In SDT [optional]
data_point str The group filter used to determine which alerts will appear in the report. Glob expression supported [optional]
sdt_filter str all sdt
rule str All alerts displayed in the report must have been routed to the Rules specified in this filter [optional]
ack_filter str all acked
sorted_direction str asc desc
device_display_name str The device filter used to determine which alerts will appear in the report. Glob expressions supported [optional]
summary_only bool true: a column will be added to the report detailing the number of times each alert occurred false: the number of times each alert occurred will not be displayed in the report [optional]
dependency_routing_state str [optional]
dependency_role str [optional]
data_source_instance_name str The instance filter used to determine which alerts will appear in the report. Glob expressions supported [optional]
data_source str All alerts displayed in the report must have been triggered for the Datasources specified in this filter [optional]
group_full_path str The group filter used to determine which alerts will appear in the report. Glob expressions supported [optional]
include_preexist object true: alerts that started prior to the specified dateRange but that meet all other criteria will be displayed in the report false: only alerts that started during the specified dateRange will be displayed in the report the default value is true [optional]

[Back to Model list] [Back to API list] [Back to README]