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

ApiTimeseriesWidget

The Timeseries widget graphs data over time, with the chosen metric displayed on the vertical axis. vertical axis

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]
min_scale	float	Minimum scale configured in the widget.	[optional]
max_scale	float	Maximum scale configured in the widget.	[optional]
unit	ApiWidgetFixedYScalePrefix		[optional]
type	str	Time Series: Line widget type.
show_timeseries_overall_baseline	bool	Displays the overall baseline if set to `true`.	[optional]
group_by	ApiAggregateProperty		[optional]
is_timeseries_one_chart_per_line	bool	Displays a separate chart for each line if set to `true`.	[optional]
data_source	TimeseriesDatasource		[optional]

Example

from dashboards.models.api_timeseries_widget import ApiTimeseriesWidget

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

# convert the object into a dict
api_timeseries_widget_dict = api_timeseries_widget_instance.to_dict()
# create an instance of ApiTimeseriesWidget from a dict
api_timeseries_widget_from_dict = ApiTimeseriesWidget.from_dict(api_timeseries_widget_dict)

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