mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2026-08-04 08:56:50 +00:00
3735dc003f
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
51 lines
3.1 KiB
Markdown
51 lines
3.1 KiB
Markdown
# ApiHeatmapWidget
|
|
|
|
Displays metric intensity across row and column groupings in a grid to help compare relative values across two dimensions.
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**id** | **str** | Identifier of the widget. | [optional] [readonly]
|
|
**title** | **str** | Title of the widget | [optional]
|
|
**visual_mode** | [**VisualMode**](VisualMode.md) | | [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**](MetricGroup.md) | | [optional]
|
|
**direction** | [**DashboardMetricDirection**](DashboardMetricDirection.md) | | [optional]
|
|
**metric** | [**DashboardMetric**](DashboardMetric.md) | | [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**](ApiWidgetMeasure.md) | | [optional]
|
|
**fixed_timespan** | [**ApiDuration**](ApiDuration.md) | | [optional]
|
|
**api_link** | **str** | | [optional] [readonly]
|
|
**should_exclude_alert_suppression_windows** | **bool** | Excludes alert suppression window data if set to `true`. | [optional]
|
|
**links** | [**SelfLinks**](SelfLinks.md) | | [optional]
|
|
**type** | **str** | Heatmap widget type. |
|
|
**row_group_by** | [**ApiAggregateProperty**](ApiAggregateProperty.md) | | [optional]
|
|
**column_group_by** | [**ApiAggregateProperty**](ApiAggregateProperty.md) | | [optional]
|
|
**sort_by** | [**LegacyWidgetSortProperty**](LegacyWidgetSortProperty.md) | | [optional]
|
|
**sort_direction** | [**LegacyWidgetSortDirection**](LegacyWidgetSortDirection.md) | | [optional]
|
|
**limit** | **int** | Limit configured in the widget. | [optional]
|
|
**data_source** | [**HeatmapDatasource**](HeatmapDatasource.md) | | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.dashboards.models.api_heatmap_widget import ApiHeatmapWidget
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of ApiHeatmapWidget from a JSON string
|
|
api_heatmap_widget_instance = ApiHeatmapWidget.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(ApiHeatmapWidget.to_json())
|
|
|
|
# convert the object into a dict
|
|
api_heatmap_widget_dict = api_heatmap_widget_instance.to_dict()
|
|
# create an instance of ApiHeatmapWidget from a dict
|
|
api_heatmap_widget_from_dict = ApiHeatmapWidget.from_dict(api_heatmap_widget_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|