gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 06:26:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
8f44835d59
thousandeyes-sdk-python/dashboards_api/README.md
Shahid Hussain Khan 8f44835d59 CP-1656 Add SDK for endpoints
2023-12-11 09:29:15 +00:00

11 KiB
Raw Blame History

dashboards-api

Manage ThousandEyes Dashboards

This Python package is automatically generated by the OpenAPI Generator 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:

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:

import dashboards_api

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 dashboards_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


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 POST /v7/dashboard-snapshots Create dashboard snapshot
DashboardSnapshotsApi dashboard_snapshot_by_id GET /v7/dashboard-snapshots/{snapshotId} Retrieve dashboard snapshot
DashboardSnapshotsApi dashboard_snapshots GET /v7/dashboard-snapshots List dashboard snapshots
DashboardSnapshotsApi delete_dashboard_snapshot DELETE /v7/dashboard-snapshots/{snapshotId} Delete dashboard snapshot
DashboardSnapshotsApi snapshot_data_by_widget GET /v7/dashboard-snapshots/{snapshotId}/widgets/{widgetId} Retrieve dashboard snapshot data
DashboardSnapshotsApi update_snapshot_expiration_date PATCH /v7/dashboard-snapshots/{snapshotId} Update snapshot expiration
DashboardsApi create_dashboard POST /v7/dashboards Create dashboard
DashboardsApi delete_dashboard DELETE /v7/dashboards/{dashboardId} Delete dashboard
DashboardsApi get_dashboard_by_id GET /v7/dashboards/{dashboardId} Retrieve dashboard
DashboardsApi get_dashboard_data GET /v7/dashboards/{dashboardId}/widgets/{widgetId} Retrieve dashboard widget data
DashboardsApi get_dashboards_for_user GET /v7/dashboards List dashboards
DashboardsApi update_dashboard PUT /v7/dashboards/{dashboardId} Update dashboard

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author