thousandeyes-sdk-python/dashboards/docs/ApiTableWidget.md

ApiTableWidget

Organizes data in rows and columns, with options to list by test, geographic location, data source, or aggregated categories.

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	SelfLinksLinks		[optional]
type	str	Table widget type.
compare_to_previous_value	bool		[optional]
row_group_by	ApiAggregateProperty		[optional]
column_group_by	ApiAggregateProperty		[optional]
sort_by	LegacyWidgetSortProperty		[optional]
sort_direction	LegacyWidgetSortDirection		[optional]
limit	int	Limit configured in the widget.	[optional]
data_source	TableDatasource		[optional]

Example

from dashboards.models.api_table_widget import ApiTableWidget

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

# convert the object into a dict
api_table_widget_dict = api_table_widget_instance.to_dict()
# create an instance of ApiTableWidget from a dict
api_table_widget_from_dict = ApiTableWidget.from_dict(api_table_widget_dict)

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