thousandeyes-sdk-test-results 2.23.0

ThousandEyes SDK Test Results API

thousandeyes-sdk-test-results

Get test result metrics for Network and Application Synthetics tests.

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

• API version: 7.0.71
• 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-test-results

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

Then import the package:

import thousandeyes_sdk.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 thousandeyes_sdk.test_results

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.test_results
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.test_results.APITestResultsApi(api_client)
    test_id = '202701' # str | Test ID
    agent_id = '11' # str | Agent ID
    round_id = '1384309800' # str | Round 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:
        # Get API test results by agent and round
        api_response = api_instance.get_test_api_agent_round_results(test_id, agent_id, round_id, aid=aid)
        print("The response of APITestResultsApi->get_test_api_agent_round_results:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APITestResultsApi->get_test_api_agent_round_results: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
APITestResultsApi	get_test_api_agent_round_results	GET /test-results/{testId}/api/agent/{agentId}/round/{roundId}	Get API test results by agent and round
APITestResultsApi	get_test_api_results	GET /test-results/{testId}/api	Get API test results
DNSSECTestResultsApi	get_test_dns_sec_results	GET /test-results/{testId}/dnssec	Get DNSSEC test results
DNSServerTestResultsApi	get_test_dns_server_result	GET /test-results/{testId}/dns-server/{serverId}	Get DNS server test results by server
DNSServerTestResultsApi	get_test_dns_servers_results	GET /test-results/{testId}/dns-server	Get DNS server test results
DNSTraceTestResultsApi	get_test_dns_trace_results	GET /test-results/{testId}/dns-trace	Get DNS trace test results
NetworkBGPTestResultsApi	get_test_bgp_results	GET /test-results/{testId}/bgp	Get BGP test results
NetworkBGPTestResultsApi	get_test_bgp_routes_prefix_round_results	GET /test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId}	Get BGP route test results by prefix
NetworkTestResultsApi	get_test_network_results	GET /test-results/{testId}/network	Get network test results
NetworkTestResultsApi	get_test_path_vis_agent_round_results	GET /test-results/{testId}/path-vis/agent/{agentId}/round/{roundId}	Get path visualization test results by agent and round
NetworkTestResultsApi	get_test_path_vis_results	GET /test-results/{testId}/path-vis	Get path visualization network test results
VoiceRTPServerTestResultsApi	get_test_rtp_server_results	GET /test-results/{testId}/rtp-server	Retrieve RTP server test metrics
VoiceSIPServerTestResultsApi	get_test_sip_server_results	GET /test-results/{testId}/sip-server	Get SIP server test results
WebFTPServerTestResultsApi	get_test_ftp_server_results	GET /test-results/{testId}/ftp-server	Get FTP server test results
WebHTTPServerTestResultsApi	get_test_http_server_results	GET /test-results/{testId}/http-server	Get HTTP server test results
WebPageLoadTestResultsApi	get_test_page_load_agent_round_results	GET /test-results/{testId}/page-load/agent/{agentId}/round/{roundId}	Get page load server test results by agent and round
WebPageLoadTestResultsApi	get_test_page_load_results	GET /test-results/{testId}/page-load	Get page load server test results
WebTransactionsTestResultsApi	get_test_web_transaction_agent_round_page_results	GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId}	Get detailed web transactions test result by agent, round, and page
WebTransactionsTestResultsApi	get_test_web_transaction_agent_round_results	GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}	Get web transactions test results by agent and round
WebTransactionsTestResultsApi	get_test_web_transaction_results	GET /test-results/{testId}/web-transactions	Get web transactions test results

Documentation For Models

• ApiDetailTestResult
• ApiDetailTestResults
• ApiRequestDetail
• ApiRequestDetailAssertion
• ApiRequestStepType
• ApiTestResult
• ApiTestResults
• AppLinks
• BgpBasicTestResult
• BgpHop
• BgpTestResult
• BgpTestResults
• BgpTestRouteInformationResult
• BgpTestRouteInformationResults
• DnsServerTestResult
• DnsServerTestResults
• DnsTraceTestResult
• DnsTraceTestResults
• DnssecTestResult
• DnssecTestResults
• EpochTimeWindow
• Error
• Expand
• FtpServerTestResult
• FtpServerTestResults
• HttpTestResult
• HttpTestResultHeaders
• HttpTestResults
• Link
• Marker
• NetworkTestResult
• NetworkTestResults
• Page
• PageLoadDetailTestResult
• PageLoadDetailTestResults
• PageLoadTestResult
• PageLoadTestResults
• PaginationLinks
• PathTrace
• PathVisBaseTestResult
• PathVisDetailTestResult
• PathVisDetailTestResults
• PathVisDirection
• PathVisHop
• PathVisRoute
• PathVisTestResult
• PathVisTestResults
• RtpStreamTestResult
• RtpStreamTestResults
• SelfLinks
• SimpleTest
• SipServerErrorType
• SipServerTestResult
• SipServerTestResults
• SslCert
• TestDirection
• TestInterval
• TestLinks
• TestResult
• TestResultAgent
• TestResultAppLinks
• TestResultMonitor
• TestSelfLink
• TestType
• UnauthorizedError
• ValidationError
• ValidationErrorItem
• WebTransactionDetailTestResult
• WebTransactionDetailTestResults
• WebTransactionPageDetailTestResult
• WebTransactionPageDetailTestResults
• WebTransactionTestResult
• WebTransactionTestResults

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: Bearer authentication

Author

ThousandEyes API Team