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

2.8 KiB

ApiPieChartWidget

Displays data as segments of a pie, with each slice representing a portion of the total value.

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 Pie Chart widget type
group_by ApiAggregateProperty [optional]
data_source PieChartDatasource [optional]

Example

from dashboards.models.api_pie_chart_widget import ApiPieChartWidget

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

# convert the object into a dict
api_pie_chart_widget_dict = api_pie_chart_widget_instance.to_dict()
# create an instance of ApiPieChartWidget from a dict
api_pie_chart_widget_from_dict = ApiPieChartWidget.from_dict(api_pie_chart_widget_dict)

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