mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 07:55:31 +00:00
ebbdbcbac7
Some checks failed
Python CI / build (push) Has been cancelled
Co-authored-by: API Team <api-team@thousandeyes.com>
45 lines
2.5 KiB
Markdown
45 lines
2.5 KiB
Markdown
# ApiNumbersCard
|
|
|
|
An individual number card within the numbers card widget.
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**min_scale** | **float** | Minimum scale configured in the widget. | [optional]
|
|
**max_scale** | **float** | Maximum scale configured in the widget. | [optional]
|
|
**unit** | [**ApiWidgetFixedYScalePrefix**](ApiWidgetFixedYScalePrefix.md) | | [optional]
|
|
**id** | **str** | Identifier of the widget. | [optional]
|
|
**description** | **str** | Description of the number card. | [optional]
|
|
**measure** | [**ApiWidgetMeasure**](ApiWidgetMeasure.md) | | [optional]
|
|
**compare_to_previous_value** | **bool** | | [optional]
|
|
**fixed_timespan** | [**ApiDuration**](ApiDuration.md) | | [optional]
|
|
**should_exclude_alert_suppression_windows** | **bool** | Excludes alert suppression windows from the widget when set to `true`. | [optional]
|
|
**data_source** | [**NumbersCardDatasource**](NumbersCardDatasource.md) | | [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]
|
|
**links** | [**SelfLinks**](SelfLinks.md) | | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from thousandeyes_sdk.dashboards.models.api_numbers_card import ApiNumbersCard
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of ApiNumbersCard from a JSON string
|
|
api_numbers_card_instance = ApiNumbersCard.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print(ApiNumbersCard.to_json())
|
|
|
|
# convert the object into a dict
|
|
api_numbers_card_dict = api_numbers_card_instance.to_dict()
|
|
# create an instance of ApiNumbersCard from a dict
|
|
api_numbers_card_from_dict = ApiNumbersCard.from_dict(api_numbers_card_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)
|
|
|
|
|