thousandeyes-sdk-python/dashboards_api/docs/ApiTableWidget.md
2023-12-11 09:29:15 +00:00

3.1 KiB

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]
type WidgetType [optional]
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 Agents, Agent Groups, Tests, Monitors, etc. The `filterValue` represents theIdentifierof 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]
compare_to_previous_value bool [optional]
row_group_by ApiAggregateProperty [optional]
column_group_by ApiAggregateProperty [optional]
sort_by WidgetSortProperty [optional]
sort_direction WidgetSortDirection [optional]
limit int Limit configured in the widget. [optional]
data_source TableDatasource [optional]

Example

from dashboards_api.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_form_dict = api_table_widget.from_dict(api_table_widget_dict)

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