|
| 1 | +# ApiListWidget |
| 2 | + |
| 3 | +A widget that displays a list of items, such as events. It can use a time range to limit the items shown. |
| 4 | + |
| 5 | +## Properties |
| 6 | + |
| 7 | +Name | Type | Description | Notes |
| 8 | +------------ | ------------- | ------------- | ------------- |
| 9 | +**id** | **str** | Identifier of the widget. | [optional] [readonly] |
| 10 | +**title** | **str** | Title of the widget | [optional] |
| 11 | +**visual_mode** | [**VisualMode**](VisualMode.md) | | [optional] |
| 12 | +**embed_url** | **str** | When `isEmbedded` is set to `true`, an `embedUrl` is provided. | [optional] [readonly] |
| 13 | +**is_embedded** | **bool** | Set to `true` if widget is marked as embedded; otherwise, set to `false`. | [optional] |
| 14 | +**metric_group** | [**MetricGroup**](MetricGroup.md) | | [optional] |
| 15 | +**direction** | [**DashboardMetricDirection**](DashboardMetricDirection.md) | | [optional] |
| 16 | +**metric** | [**DashboardMetric**](DashboardMetric.md) | | [optional] |
| 17 | +**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] |
| 18 | +**measure** | [**ApiWidgetMeasure**](ApiWidgetMeasure.md) | | [optional] |
| 19 | +**fixed_timespan** | [**ApiDuration**](ApiDuration.md) | | [optional] |
| 20 | +**api_link** | **str** | | [optional] [readonly] |
| 21 | +**should_exclude_alert_suppression_windows** | **bool** | Excludes alert suppression window data if set to `true`. | [optional] |
| 22 | +**links** | [**SelfLinks**](SelfLinks.md) | | [optional] |
| 23 | +**type** | **str** | List widget type. Currently supports only `List`. | |
| 24 | +**sort_direction** | [**LegacyWidgetSortDirection**](LegacyWidgetSortDirection.md) | | [optional] |
| 25 | +**active_within** | [**ActiveWithin**](ActiveWithin.md) | | [optional] |
| 26 | +**data_source** | [**ListDatasource**](ListDatasource.md) | | [optional] |
| 27 | + |
| 28 | +## Example |
| 29 | + |
| 30 | +```python |
| 31 | +from thousandeyes_sdk.dashboards.models.api_list_widget import ApiListWidget |
| 32 | + |
| 33 | +# TODO update the JSON string below |
| 34 | +json = "{}" |
| 35 | +# create an instance of ApiListWidget from a JSON string |
| 36 | +api_list_widget_instance = ApiListWidget.from_json(json) |
| 37 | +# print the JSON string representation of the object |
| 38 | +print(ApiListWidget.to_json()) |
| 39 | + |
| 40 | +# convert the object into a dict |
| 41 | +api_list_widget_dict = api_list_widget_instance.to_dict() |
| 42 | +# create an instance of ApiListWidget from a dict |
| 43 | +api_list_widget_from_dict = ApiListWidget.from_dict(api_list_widget_dict) |
| 44 | +``` |
| 45 | +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
| 46 | + |
| 47 | + |
0 commit comments