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
73d1f2972c
thousandeyes-sdk-python/endpoint_test_results/README.md

17 KiB
Raw Blame History

endpoint-test-results

Retrieve results for scheduled and dynamic tests on endpoint agents.

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

  • API version: 7.0.2
  • Package version: 1.0.0
  • Generator version: 7.5.0
  • Build package: com.thousandeyes.api.codegen.ThousandeyesPythonGenerator

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/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import endpoint_test_results

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 endpoint_test_results

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import endpoint_test_results
from endpoint_test_results.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 = endpoint_test_results.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 = endpoint_test_results.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with endpoint_test_results.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = endpoint_test_results.LocalNetworkTestsResultsApi(api_client)
    network_topology_id = '00160:39c518560de9:1491651900:236e6f18' # str | The network topology ID.
    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:
        # Retrieve endpoint local network topology
        api_response = api_instance.get_endpoint_local_network_topology_details(network_topology_id, aid=aid)
        print("The response of LocalNetworkTestsResultsApi->get_endpoint_local_network_topology_details:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling LocalNetworkTestsResultsApi->get_endpoint_local_network_topology_details: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
LocalNetworkTestsResultsApi get_endpoint_local_network_topology_details GET /v7/endpoint/test-results/local-networks/topologies/{networkTopologyId} Retrieve endpoint local network topology
LocalNetworkTestsResultsApi get_endpoint_local_networks GET /v7/endpoint/test-results/local-networks List local networks
LocalNetworkTestsResultsApi get_endpoint_local_networks_topologies POST /v7/endpoint/test-results/local-networks/topologies/filter List endpoint network topologies probes
NetworkDynamicTestsResultsApi get_dynamic_test_result_network_pathvis GET /v7/endpoint/test-results/dynamic-tests/{testId}/path-vis Retrieve path visualization network dynamic test results
NetworkDynamicTestsResultsApi get_dynamic_test_result_pathvis_agent_round GET /v7/endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network dynamic test results details
NetworkDynamicTestsResultsApi post_fetch_dynamic_test_result_metrics POST /v7/endpoint/test-results/dynamic-tests/{testId}/network/filter Retrieve network dynamic test results
NetworkScheduledTestsResultsApi get_test_result_network_pathvis GET /v7/endpoint/test-results/scheduled-tests/{testId}/path-vis Retrieve path visualization network scheduled test results
NetworkScheduledTestsResultsApi get_test_result_pathvis_agent_round GET /v7/endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network scheduled test results details
NetworkScheduledTestsResultsApi post_fetch_test_result_metrics POST /v7/endpoint/test-results/scheduled-tests/{testId}/network/filter Retrieve network scheduled test results
NetworkScheduledTestsResultsApi post_fetch_test_result_metrics_multi_test POST /v7/endpoint/test-results/scheduled-tests/network/filter Retrieve network scheduled test results from multiple tests
RealUserTestsResultsApi get_endpoint_real_user_test_details GET /v7/endpoint/test-results/real-user-tests/{id} Retrieve endpoint real user test
RealUserTestsResultsApi get_endpoint_real_user_test_pages_details GET /v7/endpoint/test-results/real-user-tests/{id}/pages/{pageId} Retrieve endpoint real user test page
RealUserTestsResultsApi get_endpoint_real_user_tests POST /v7/endpoint/test-results/real-user-tests/filter List endpoint real user tests
RealUserTestsResultsApi get_endpoint_real_user_tests_network POST /v7/endpoint/test-results/real-user-tests/networks/filter List endpoint real user tests
RealUserTestsResultsApi get_endpoint_real_user_tests_pages POST /v7/endpoint/test-results/real-user-tests/pages/filter List endpoint real user tests visited pages
WebHTTPServerScheduledTestResultsApi get_test_result_http_server GET /v7/endpoint/test-results/scheduled-tests/{testId}/http-server Retrieve HTTP server scheduled test results

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author