thousandeyes-sdk-dashboards 1.3.0

ThousandEyes SDK Dashboards API

thousandeyes-sdk-dashboards

Manage ThousandEyes Dashboards.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.0.15
• Generator version: 7.6.0
• Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

Requirements.

Python 3.8+

Installation & Usage

pip install

Install directly via PyPi:

pip install thousandeyes-sdk-dashboards

(you may need to run pip with root permission: sudo pip install thousandeyes-sdk-dashboards)

Then import the package:

import thousandeyes_sdk.dashboards

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import thousandeyes_sdk.dashboards

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import thousandeyes_sdk.core
import thousandeyes_sdk.dashboards
from thousandeyes_sdk.core.exceptions import ApiException
from pprint import pprint

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

# 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 = thousandeyes_sdk.core.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with thousandeyes_sdk.core.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.dashboards.DashboardSnapshotsApi(api_client)
    generate_dashboard_snapshot_request = thousandeyes_sdk.dashboards.GenerateDashboardSnapshotRequest() # GenerateDashboardSnapshotRequest | Request body schema to create a dashboard snapshot.
    aid = '1234' # 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/v7

Class	Method	HTTP request	Description
DashboardSnapshotsApi	create_dashboard_snapshot	POST /dashboard-snapshots	Create dashboard snapshot
DashboardSnapshotsApi	delete_dashboard_snapshot	DELETE /dashboard-snapshots/{snapshotId}	Delete dashboard snapshot
DashboardSnapshotsApi	get_dashboard_snapshot	GET /dashboard-snapshots/{snapshotId}	Retrieve dashboard snapshot
DashboardSnapshotsApi	get_dashboard_snapshot_widget_data	GET /dashboard-snapshots/{snapshotId}/widgets/{widgetId}	Retrieve dashboard snapshot data
DashboardSnapshotsApi	get_dashboard_snapshots	GET /dashboard-snapshots	List dashboard snapshots
DashboardSnapshotsApi	update_dashboard_snapshot_expiration_date	PATCH /dashboard-snapshots/{snapshotId}	Update snapshot expiration
DashboardsApi	create_dashboard	POST /dashboards	Create dashboard
DashboardsApi	delete_dashboard	DELETE /dashboards/{dashboardId}	Delete dashboard
DashboardsApi	get_dashboard	GET /dashboards/{dashboardId}	Retrieve dashboard
DashboardsApi	get_dashboard_widget_data	GET /dashboards/{dashboardId}/widgets/{widgetId}	Retrieve dashboard widget data
DashboardsApi	get_dashboards	GET /dashboards	List dashboards
DashboardsApi	update_dashboard	PUT /dashboards/{dashboardId}	Update dashboard
DashboardsFiltersApi	create_dashboard_filter	POST /dashboards/filters	Create dashboard filter
DashboardsFiltersApi	delete_dashboard_filter	DELETE /dashboards/filters/{id}	Delete dashboard filter
DashboardsFiltersApi	get_dashboard_filter	GET /dashboards/filters/{id}	Get dashboard filter
DashboardsFiltersApi	get_dashboards_filters	GET /dashboards/filters	List dashboard filters
DashboardsFiltersApi	update_dashboard_filter	PUT /dashboards/filters/{id}	Update dashboard filter

Documentation For Models

• ActiveWithin
• AgentStatusDatasource
• AlertListAlertType
• AlertListDatasource
• ApiAgentLocation
• ApiAgentStatusAgent
• ApiAgentStatusIpInfo
• ApiAgentStatusSummary
• ApiAgentStatusWidget
• ApiAgentWidgetShow
• ApiAgentWidgetType
• ApiAggregateProperty
• ApiAlertListAlert
• ApiAlertListWidget
• ApiBoxAndWhiskersWidget
• ApiColorGridWidget
• ApiContextFilterRequest
• ApiContextFilterResponse
• ApiContextFiltersResponse
• ApiDashboard
• ApiDashboardAsw
• ApiDashboardFilterUserDetails
• ApiDashboardSnapshot
• ApiDataPointGroup
• ApiDataSourceFilter
• ApiDataSourceFilters
• ApiDefaultTimespan
• ApiDuration
• ApiDurationUnit
• ApiGeoMapWidget
• ApiGraphletPoint
• ApiGroupedBarchartWidget
• ApiMultiMetricColumn
• ApiMultiMetricColumnData
• ApiMultiMetricTableWidget
• ApiMultiSearchFilterApiTestTableFilterKey
• ApiNumbersCard
• ApiNumbersCardData
• ApiNumbersCardWidget
• ApiPieChartWidget
• ApiReportDataComponentLabelMap
• ApiReportDataComponentLabelMapEntry
• ApiReportSnapshotTimeSpan
• ApiStackedAreaChartWidget
• ApiStackedBarchartWidget
• ApiTableWidget
• ApiTestTableData
• ApiTestTableGraphletsData
• ApiTestTableWidget
• ApiTimeseriesWidget
• ApiWidget
• ApiWidgetData
• ApiWidgetDataPoint
• ApiWidgetDataResponse
• ApiWidgetDataSnapshotResponse
• ApiWidgetFilterApiTestTableFilterKey
• ApiWidgetFixedYScalePrefix
• ApiWidgetMeasure
• ApiWidgetSortDirection
• ApiWidgetSortProperty
• ApiWidgetsDataV2
• AppAndSelfLinks
• AswRepeat
• AswRepeatUnit
• BoxAndWhiskersDatasource
• ColorGridDatasource
• Dashboard
• DashboardGlobalFilterId
• DashboardLinks
• DashboardMetric
• DashboardMetricDirection
• DashboardOrder
• DashboardSnapshotResponse
• DashboardSnapshotsPage
• DefaultTimespan
• EnterpriseAgentState
• Error
• GenerateDashboardSnapshotRequest
• GeoMapDatasource
• GroupedBarChartDatasource
• LegacyAgentWidgetShow
• LegacyAgentWidgetType
• LegacyAlertListAlertType
• LegacyApiDashboard
• LegacyDashboardSnapshot
• LegacyDefaultTimespan
• LegacyDurationUnit
• LegacyWidgetSortDirection
• LegacyWidgetSortProperty
• Link
• MetricGroup
• MultiMetricsTableDatasource
• NumbersCardDatasource
• PaginationLinks
• PieChartDatasource
• ScalableWidget
• SelfLinks
• StackedAreaChartDatasource
• StackedBarChartDatasource
• TableDatasource
• TestTableDatasource
• TestTableFilterKey
• TestTableFilterType
• TimeseriesDatasource
• UnauthorizedError
• UpdateSnapshotExpirationDateApiRequest
• ValidationError
• ValidationErrorItem
• VisualMode
• Widget
• WidgetMeasureType
• WidgetType

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team