# dashboards-api
Manage ThousandEyes Dashboards

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/thousandeyes/thousandeyes-python-sdk.git`)

Then import the package:
```python
import dashboards_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import dashboards_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import time
import dashboards_api
from dashboards_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.thousandeyes.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dashboards_api.Configuration(
    host = "https://api.thousandeyes.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: BearerAuth
configuration = dashboards_api.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with dashboards_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dashboards_api.DashboardSnapshotsApi(api_client)
    generate_dashboard_snapshot_request = dashboards_api.GenerateDashboardSnapshotRequest() # GenerateDashboardSnapshotRequest | Request body schema to create a dashboard snapshot.
    aid = '2067' # str | A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. Note that you must be assigned to the target account group. Specifying this parameter without being assigned to the target account group will result in an error response. (optional)

    try:
        # Create dashboard snapshot
        api_response = api_instance.create_dashboard_snapshot(generate_dashboard_snapshot_request, aid=aid)
        print("The response of DashboardSnapshotsApi->create_dashboard_snapshot:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DashboardSnapshotsApi->create_dashboard_snapshot: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.thousandeyes.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DashboardSnapshotsApi* | [**create_dashboard_snapshot**](docs/DashboardSnapshotsApi.md#create_dashboard_snapshot) | **POST** /v7/dashboard-snapshots | Create dashboard snapshot
*DashboardSnapshotsApi* | [**dashboard_snapshot_by_id**](docs/DashboardSnapshotsApi.md#dashboard_snapshot_by_id) | **GET** /v7/dashboard-snapshots/{snapshotId} | Retrieve dashboard snapshot
*DashboardSnapshotsApi* | [**dashboard_snapshots**](docs/DashboardSnapshotsApi.md#dashboard_snapshots) | **GET** /v7/dashboard-snapshots | List dashboard snapshots
*DashboardSnapshotsApi* | [**delete_dashboard_snapshot**](docs/DashboardSnapshotsApi.md#delete_dashboard_snapshot) | **DELETE** /v7/dashboard-snapshots/{snapshotId} | Delete dashboard snapshot
*DashboardSnapshotsApi* | [**snapshot_data_by_widget**](docs/DashboardSnapshotsApi.md#snapshot_data_by_widget) | **GET** /v7/dashboard-snapshots/{snapshotId}/widgets/{widgetId} | Retrieve dashboard snapshot data
*DashboardSnapshotsApi* | [**update_snapshot_expiration_date**](docs/DashboardSnapshotsApi.md#update_snapshot_expiration_date) | **PATCH** /v7/dashboard-snapshots/{snapshotId} | Update snapshot expiration
*DashboardsApi* | [**create_dashboard**](docs/DashboardsApi.md#create_dashboard) | **POST** /v7/dashboards | Create dashboard
*DashboardsApi* | [**delete_dashboard**](docs/DashboardsApi.md#delete_dashboard) | **DELETE** /v7/dashboards/{dashboardId} | Delete dashboard
*DashboardsApi* | [**get_dashboard_by_id**](docs/DashboardsApi.md#get_dashboard_by_id) | **GET** /v7/dashboards/{dashboardId} | Retrieve dashboard
*DashboardsApi* | [**get_dashboard_data**](docs/DashboardsApi.md#get_dashboard_data) | **GET** /v7/dashboards/{dashboardId}/widgets/{widgetId} | Retrieve dashboard widget data
*DashboardsApi* | [**get_dashboards_for_user**](docs/DashboardsApi.md#get_dashboards_for_user) | **GET** /v7/dashboards | List dashboards
*DashboardsApi* | [**update_dashboard**](docs/DashboardsApi.md#update_dashboard) | **PUT** /v7/dashboards/{dashboardId} | Update dashboard


## Documentation For Models

 - [AgentStatusDatasource](docs/AgentStatusDatasource.md)
 - [AgentWidgetShow](docs/AgentWidgetShow.md)
 - [AgentWidgetType](docs/AgentWidgetType.md)
 - [AlertListDatasource](docs/AlertListDatasource.md)
 - [ApiAgentLocation](docs/ApiAgentLocation.md)
 - [ApiAgentStatusAgent](docs/ApiAgentStatusAgent.md)
 - [ApiAgentStatusIpInfo](docs/ApiAgentStatusIpInfo.md)
 - [ApiAgentStatusSummary](docs/ApiAgentStatusSummary.md)
 - [ApiAgentStatusWidget](docs/ApiAgentStatusWidget.md)
 - [ApiAggregateProperty](docs/ApiAggregateProperty.md)
 - [ApiAlertListAlert](docs/ApiAlertListAlert.md)
 - [ApiAlertListAlertType](docs/ApiAlertListAlertType.md)
 - [ApiAlertListWidget](docs/ApiAlertListWidget.md)
 - [ApiAlertListWidgetAllOfActiveWithin](docs/ApiAlertListWidgetAllOfActiveWithin.md)
 - [ApiBoxAndWhiskersWidget](docs/ApiBoxAndWhiskersWidget.md)
 - [ApiColorGridWidget](docs/ApiColorGridWidget.md)
 - [ApiDashboard](docs/ApiDashboard.md)
 - [ApiDashboardAsw](docs/ApiDashboardAsw.md)
 - [ApiDashboardSnapshot](docs/ApiDashboardSnapshot.md)
 - [ApiDashboardSnapshotAllOfDashboard](docs/ApiDashboardSnapshotAllOfDashboard.md)
 - [ApiDataPointGroup](docs/ApiDataPointGroup.md)
 - [ApiDefaultTimespan](docs/ApiDefaultTimespan.md)
 - [ApiDuration](docs/ApiDuration.md)
 - [ApiGeoMapWidget](docs/ApiGeoMapWidget.md)
 - [ApiGraphletPoint](docs/ApiGraphletPoint.md)
 - [ApiGroupedBarchartWidget](docs/ApiGroupedBarchartWidget.md)
 - [ApiMultiMetricColumn](docs/ApiMultiMetricColumn.md)
 - [ApiMultiMetricColumnData](docs/ApiMultiMetricColumnData.md)
 - [ApiMultiMetricTableWidget](docs/ApiMultiMetricTableWidget.md)
 - [ApiMultiSearchFilterApiTestTableFilterKey](docs/ApiMultiSearchFilterApiTestTableFilterKey.md)
 - [ApiNumbersCard](docs/ApiNumbersCard.md)
 - [ApiNumbersCardAllOfFixedTimespan](docs/ApiNumbersCardAllOfFixedTimespan.md)
 - [ApiNumbersCardData](docs/ApiNumbersCardData.md)
 - [ApiNumbersCardWidget](docs/ApiNumbersCardWidget.md)
 - [ApiPieChartWidget](docs/ApiPieChartWidget.md)
 - [ApiReportDataComponentLabelMap](docs/ApiReportDataComponentLabelMap.md)
 - [ApiReportDataComponentLabelMapEntry](docs/ApiReportDataComponentLabelMapEntry.md)
 - [ApiReportSnapshotTimeSpan](docs/ApiReportSnapshotTimeSpan.md)
 - [ApiStackedAreaChartWidget](docs/ApiStackedAreaChartWidget.md)
 - [ApiStackedBarchartWidget](docs/ApiStackedBarchartWidget.md)
 - [ApiTableWidget](docs/ApiTableWidget.md)
 - [ApiTestTableData](docs/ApiTestTableData.md)
 - [ApiTestTableGraphletsData](docs/ApiTestTableGraphletsData.md)
 - [ApiTestTableWidget](docs/ApiTestTableWidget.md)
 - [ApiTimeseriesWidget](docs/ApiTimeseriesWidget.md)
 - [ApiWidget](docs/ApiWidget.md)
 - [ApiWidgetDataPoint](docs/ApiWidgetDataPoint.md)
 - [ApiWidgetDataResponse](docs/ApiWidgetDataResponse.md)
 - [ApiWidgetFilterApiTestTableFilterKey](docs/ApiWidgetFilterApiTestTableFilterKey.md)
 - [ApiWidgetFixedYScalePrefix](docs/ApiWidgetFixedYScalePrefix.md)
 - [ApiWidgetMeasure](docs/ApiWidgetMeasure.md)
 - [ApiWidgetsDataV2](docs/ApiWidgetsDataV2.md)
 - [AswRepeat](docs/AswRepeat.md)
 - [AswRepeatUnit](docs/AswRepeatUnit.md)
 - [BoxAndWhiskersDatasource](docs/BoxAndWhiskersDatasource.md)
 - [ColorGridDatasource](docs/ColorGridDatasource.md)
 - [DashboardLinks](docs/DashboardLinks.md)
 - [DashboardLinksLinks](docs/DashboardLinksLinks.md)
 - [DashboardMetric](docs/DashboardMetric.md)
 - [DashboardMetricDirection](docs/DashboardMetricDirection.md)
 - [DashboardOrder](docs/DashboardOrder.md)
 - [DashboardSnapshotLinks](docs/DashboardSnapshotLinks.md)
 - [DashboardSnapshotLinksLinks](docs/DashboardSnapshotLinksLinks.md)
 - [DashboardSnapshots200Response](docs/DashboardSnapshots200Response.md)
 - [DashboardSnapshotsPage](docs/DashboardSnapshotsPage.md)
 - [DurationUnit](docs/DurationUnit.md)
 - [EnterpriseAgentState](docs/EnterpriseAgentState.md)
 - [Error](docs/Error.md)
 - [GenerateDashboardSnapshotRequest](docs/GenerateDashboardSnapshotRequest.md)
 - [GeoMapDatasource](docs/GeoMapDatasource.md)
 - [GetDashboardData200Response](docs/GetDashboardData200Response.md)
 - [GroupedBarChartDatasource](docs/GroupedBarChartDatasource.md)
 - [Link](docs/Link.md)
 - [MetricGroup](docs/MetricGroup.md)
 - [MultiMetricsTableDatasource](docs/MultiMetricsTableDatasource.md)
 - [NumbersCardDatasource](docs/NumbersCardDatasource.md)
 - [PaginationLinks](docs/PaginationLinks.md)
 - [PaginationLinksLinks](docs/PaginationLinksLinks.md)
 - [PieChartDatasource](docs/PieChartDatasource.md)
 - [QueryWindow](docs/QueryWindow.md)
 - [ScalableWidget](docs/ScalableWidget.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [SelfLinksLinks](docs/SelfLinksLinks.md)
 - [SnapshotDataByWidget200Response](docs/SnapshotDataByWidget200Response.md)
 - [StackedAreaChartDatasource](docs/StackedAreaChartDatasource.md)
 - [StackedBarChartDatasource](docs/StackedBarChartDatasource.md)
 - [TableDatasource](docs/TableDatasource.md)
 - [TestTableDatasource](docs/TestTableDatasource.md)
 - [TestTableFilterKey](docs/TestTableFilterKey.md)
 - [TestTableFilterType](docs/TestTableFilterType.md)
 - [TimeseriesDatasource](docs/TimeseriesDatasource.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [UpdateSnapshotExpirationDateApiRequest](docs/UpdateSnapshotExpirationDateApiRequest.md)
 - [VisualMode](docs/VisualMode.md)
 - [Widget](docs/Widget.md)
 - [WidgetMeasureType](docs/WidgetMeasureType.md)
 - [WidgetSortDirection](docs/WidgetSortDirection.md)
 - [WidgetSortProperty](docs/WidgetSortProperty.md)
 - [WidgetType](docs/WidgetType.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author




