mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 14:36:50 +00:00
2.8 KiB
2.8 KiB
ApiNumbersCardWidget
A widget composed of multiple cards, each presenting a singular metric, such as average packet loss, page load time, or alert count.
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 | Number widget type. | |
| number_cards | **List[ApiNumbersCard]** | [optional] | |
| data_source | NumbersCardDatasource | [optional] |
Example
from thousandeyes_sdk.dashboards.models.api_numbers_card_widget import ApiNumbersCardWidget
# TODO update the JSON string below
json = "{}"
# create an instance of ApiNumbersCardWidget from a JSON string
api_numbers_card_widget_instance = ApiNumbersCardWidget.from_json(json)
# print the JSON string representation of the object
print(ApiNumbersCardWidget.to_json())
# convert the object into a dict
api_numbers_card_widget_dict = api_numbers_card_widget_instance.to_dict()
# create an instance of ApiNumbersCardWidget from a dict
api_numbers_card_widget_from_dict = ApiNumbersCardWidget.from_dict(api_numbers_card_widget_dict)