thousandeyes-sdk-python/thousandeyes-sdk-dashboards/docs/ApiDashboardSnapshot.md
Jack Browne 92b9a0126c
CP-2126 Refactor HTTP client into shared package (#5)
* CP-2126 Refactor HTTP client into shared package

* CP-2126 Regenerate Python SDK
2024-05-23 11:57:23 +01:00

45 lines
2.7 KiB
Markdown

# ApiDashboardSnapshot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **int** | Identifier of the account group that the snapshot belongs to. | [optional]
**created_date** | **str** | UTC date when dashboard snapshot was created. | [optional]
**expiration_date** | **str** | Expiration date of the snapshot. If unspecified, the snapshot expires 1 year from its creation date. The expiration date must be set within 5 years from the current date. | [optional]
**permalink** | **str** | Hyperlink to dashboard snapshot in ThousandEyes Application | [optional]
**api_links** | **List[Dict[str, object]]** | A links array containing the self link. | [optional]
**snapshot_id** | **str** | Identifier of the dashboard snapshot. | [optional]
**snapshot_name** | **str** | Name of the dashboard snapshot. | [optional]
**aid** | **str** | Identifier of the account group that the snapshot belongs to. | [optional]
**is_shared** | **bool** | Set `true` if dashboard snapshot is shared, `false` otherwise. | [optional]
**snapshot_created_date** | **datetime** | UTC date when dashboard snapshot was created (ISO date-time format). | [optional]
**dashboard** | [**ApiDashboard**](ApiDashboard.md) | | [optional]
**widgets** | [**List[ApiWidget]**](ApiWidget.md) | | [optional]
**is_scheduled** | **bool** | Set `true` if dashboard snapshot was generated from a schedule, `false` otherwise. | [optional]
**time_span** | [**ApiReportSnapshotTimeSpan**](ApiReportSnapshotTimeSpan.md) | | [optional]
**snapshot_expiration_date** | **datetime** | Expiration date of the snapshot. If unspecified, the snapshot expires 1 year from its creation date. The expiration date must be set within 5 years from the current date and adhere to the ISO date-time format. | [optional]
**links** | [**AppAndSelfLinks**](AppAndSelfLinks.md) | | [optional]
## Example
```python
from thousandeyes_sdk.dashboards.models.api_dashboard_snapshot import ApiDashboardSnapshot
# TODO update the JSON string below
json = "{}"
# create an instance of ApiDashboardSnapshot from a JSON string
api_dashboard_snapshot_instance = ApiDashboardSnapshot.from_json(json)
# print the JSON string representation of the object
print(ApiDashboardSnapshot.to_json())
# convert the object into a dict
api_dashboard_snapshot_dict = api_dashboard_snapshot_instance.to_dict()
# create an instance of ApiDashboardSnapshot from a dict
api_dashboard_snapshot_from_dict = ApiDashboardSnapshot.from_dict(api_dashboard_snapshot_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)