thousandeyes-sdk-dashboards

Manage ThousandEyes Dashboards.

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

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

Requirements.

Python 3.9+

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	clone_dashboard	POST /dashboards/{dashboardId}/clone	Clone dashboard
DashboardsApi	create_dashboard	POST /dashboards	Create dashboard
DashboardsApi	delete_dashboard	DELETE /dashboards/{dashboardId}	Delete dashboard
DashboardsApi	delete_dashboard_schedule	DELETE /dashboards/{dashboardId}/actions/schedule	Delete dashboard snapshot schedule
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	get_individual_card_data	GET /dashboards/{dashboardId}/widgets/{widgetId}/cards/{cardId}	Retrieve individual card data from numbers widget
DashboardsApi	get_individual_column_data	GET /dashboards/{dashboardId}/widgets/{widgetId}/columns/{columnId}	Retrieve individual column data from multi-metric table widget
DashboardsApi	update_dashboard	PUT /dashboards/{dashboardId}	Update dashboard
DashboardsApi	update_dashboard_schedule	PUT /dashboards/{dashboardId}/actions/schedule	Create or update dashboard snapshot schedule
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

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication

Author

ThousandEyes API Team

Metadata

Release files for thousandeyes-sdk-dashboards 5.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for thousandeyes-sdk-dashboards 5.0.1
File	Size	Uploaded
thousandeyes_sdk_dashboards-5.0.1.tar.gz	153.5 kB	Sep 9, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for thousandeyes-sdk-dashboards 5.0.1
File	Interpreter	ABI	Platform	Reset
thousandeyes_sdk_dashboards-5.0.1-py3-none-any.whl 249.9 kB Sep 9, 2026	Python 3	none	any	Details

Total release size: 403.3 kB

Release files / thousandeyes_sdk_dashboards-5.0.1.tar.gz

Download URL	thousandeyes_sdk_dashboards-5.0.1.tar.gz
Size	153.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`6293313e44a32c911ab66bd821c52d698e92fdb7874ce4b32974a3a8c6bfa8f6`
BLAKE2b-256 checksum How to use checksums	`b6f1ec9c97b2f56b19ad5de2555f115c7c40828c89fd21c91b81bd119dd0cd2e`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/9fa78bf5ac190335dc468a8eec289addfcb58e8f

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/9fa78bf5ac190335dc468a8eec289addfcb58e8f/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34374680639/attempts/1

Artifact

Subject: thousandeyes_sdk_dashboards-5.0.1.tar.gz
SHA-256 checksum: 6293313e44a32c911ab66bd821c52d698e92fdb7874ce4b32974a3a8c6bfa8f6 Verifying attestations

Release files / thousandeyes_sdk_dashboards-5.0.1-py3-none-any.whl

Download URL	thousandeyes_sdk_dashboards-5.0.1-py3-none-any.whl
Size	249.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`76fee80075f5b7a808251377c2188751a6e8047f23d12b2f20e5df2e069a16e1`
BLAKE2b-256 checksum How to use checksums	`d13f49a7ea11958b17758a28efa57b331f891f78fd1beea9467fa8c271e412ab`
Upload date	Sep 9, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/thousandeyes/thousandeyes-sdk-python
Publishing commit: github.com/thousandeyes/thousandeyes-sdk-python/tree/9fa78bf5ac190335dc468a8eec289addfcb58e8f

Workflow

Publishing configuration: github.com/thousandeyes/thousandeyes-sdk-python/blob/9fa78bf5ac190335dc468a8eec289addfcb58e8f/.github/workflows/release.yaml
Publishing logs: github.com/thousandeyes/thousandeyes-sdk-python/actions/runs/34374680639/attempts/1

Artifact

Subject: thousandeyes_sdk_dashboards-5.0.1-py3-none-any.whl
SHA-256 checksum: 76fee80075f5b7a808251377c2188751a6e8047f23d12b2f20e5df2e069a16e1 Verifying attestations