thousandeyes-sdk-python/thousandeyes-sdk-dashboards/docs/ApiAlertListWidget.md
Ting df1bc2ab2f
Some checks failed
Python CI / build (push) Has been cancelled
[GitHub Bot] Generated python SDK (#114)
Co-authored-by: API Team <api-team@thousandeyes.com>
2025-09-30 14:36:04 +01:00

3.0 KiB

ApiAlertListWidget

A widget that displays a list of alerts based on specified criteria, such as alert type and time frame.

Properties

Name Type Description Notes
id str Identifier of the widget. [optional] [readonly]
title str Title of the widget [optional]
visual_mode VisualMode [optional]
embed_url str When `isEmbedded` is set to `true`, an `embedUrl` is provided. [optional] [readonly]
is_embedded bool Set to `true` if widget is marked as embedded; otherwise, set to `false`. [optional]
metric_group MetricGroup [optional]
direction DashboardMetricDirection [optional]
metric DashboardMetric [optional]
filters Dict[str, List[object]] (Optional) Specifies the filters applied to the widget. When present, the `filters` property displays. Each filter object has two properties: `filterProperty` and `filterValue`. The `filterProperty` can be values like `AGENT`, `ENDPOINT_MACHINE_ID`, `TEST`, `MONITOR`, etc. The `filterValue` represents an identifier array of the selected property. [optional]
measure ApiWidgetMeasure [optional]
fixed_timespan ApiDuration [optional]
api_link str [optional] [readonly]
should_exclude_alert_suppression_windows bool Excludes alert suppression window data if set to `true`. [optional]
links SelfLinks [optional]
type str Alert List widget type.
alert_types **List[LegacyAlertListAlertType]** List of alert types configured in the widget, an empty list means all alert types. [optional]
limit_to int Limit the number of alerts displayed in the widget. [optional]
active_within ActiveWithin [optional]
data_source AlertListDatasource [optional]

Example

from thousandeyes_sdk.dashboards.models.api_alert_list_widget import ApiAlertListWidget

# TODO update the JSON string below
json = "{}"
# create an instance of ApiAlertListWidget from a JSON string
api_alert_list_widget_instance = ApiAlertListWidget.from_json(json)
# print the JSON string representation of the object
print(ApiAlertListWidget.to_json())

# convert the object into a dict
api_alert_list_widget_dict = api_alert_list_widget_instance.to_dict()
# create an instance of ApiAlertListWidget from a dict
api_alert_list_widget_from_dict = ApiAlertListWidget.from_dict(api_alert_list_widget_dict)

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