thousandeyes-sdk-python/thousandeyes-sdk-dashboards/docs/Widget.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

2.3 KiB

Widget

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]

Example

from thousandeyes_sdk.dashboards.models.widget import Widget

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

# convert the object into a dict
widget_dict = widget_instance.to_dict()
# create an instance of Widget from a dict
widget_from_dict = Widget.from_dict(widget_dict)

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