Skip to main content

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.2

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.2
File Size Uploaded Provenance Actions
thousandeyes_sdk_dashboards-5.0.2.tar.gz 153.5 kB With provenance Details for thousandeyes_sdk_dashboards-5.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for thousandeyes-sdk-dashboards 5.0.2
File Interpreter ABI Platform Actions
thousandeyes_sdk_dashboards-5.0.2-py3-none-any.whl Python 3 none any Details for thousandeyes_sdk_dashboards-5.0.2-py3-none-any.whl

Total release size: 403.3 kB

Release files / thousandeyes_sdk_dashboards-5.0.2.tar.gz

Download URL thousandeyes_sdk_dashboards-5.0.2.tar.gz
Size 153.5 kB
Tags Source
SHA-256 checksum
How to use checksums
04f2c4664b49986c998b218b0773c47498405f9644ec3ae115a2d92452c8bab2
BLAKE2b-256 checksum
How to use checksums
2d54b5b1bf32d0bb22a3eccf3a6ddcfd1e12e1e1d8530f042031bb3139838b54
Upload date
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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

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

Download URL thousandeyes_sdk_dashboards-5.0.2-py3-none-any.whl
Size 249.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5c63cb85c5d85fe29f797d9016bfd479f1c4431210d001991c57a67274594789
BLAKE2b-256 checksum
How to use checksums
19eecf61ac8e7fadce5a794a2e5adb09e99317e61f39a3ac63e58a1ce4d798e7
Upload date
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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

Security for thousandeyes-sdk-dashboards 5.0.2

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for thousandeyes_sdk_dashboards-5.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 13, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

5.0.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page