ThousandEyes SDK Endpoint Test Results API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cisco-open from gravatar.com cisco-open

Unverified details

These details have not been verified by PyPI
Meta
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR U...
  • Author: ThousandEyes API Team
  • Requires: Python >=3.8
  • Provides-Extra: dev , test
Report project as malware

Project description

thousandeyes-sdk-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.25
  • 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-endpoint-test-results

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

Then import the package:

import thousandeyes_sdk.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 thousandeyes_sdk.endpoint_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.endpoint_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.endpoint_test_results.HTTPServerEndpointScheduledTestResultsApi(api_client)
    test_id = '202701' # str | Test 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)
    window = '12h' # str | A dynamic time interval up to the current time of the request. Specify the interval as a number followed by an optional type: `s` for seconds (default if no type is specified), `m` for minutes, `h` for hours, `d` for days, and `w` for weeks. For a precise date range, use `startDate` and `endDate`. (optional)
    start_date = '2022-07-17T22:00:54Z' # datetime | Use with the `endDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
    end_date = '2022-07-18T22:00:54Z' # datetime | Defaults to current time the request is made. Use with the `startDate` parameter. Include the complete time (hours, minutes, and seconds) in UTC time zone, following the ISO 8601 date-time format. See the example for reference. Please note that this parameter can't be used with `window`. (optional)
    cursor = 'cursor_example' # str | (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. (optional)
    expand = [thousandeyes_sdk.endpoint_test_results.ExpandEndpointHttpServerOptions()] # List[ExpandEndpointHttpServerOptions] | This parameter is optional and determines whether to expand resources related to test results. By default, no expansion occurs when this query parameter is omitted. To expand a specific resource, such as \"header,\" append `?expand=header` to the query. (optional)

    try:
        # Retrieve HTTP server scheduled test results
        api_response = api_instance.get_http_server_scheduled_test_results(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, expand=expand)
        print("The response of HTTPServerEndpointScheduledTestResultsApi->get_http_server_scheduled_test_results:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling HTTPServerEndpointScheduledTestResultsApi->get_http_server_scheduled_test_results: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
HTTPServerEndpointScheduledTestResultsApi get_http_server_scheduled_test_results GET /endpoint/test-results/scheduled-tests/{testId}/http-server Retrieve HTTP server scheduled test results
HTTPServerEndpointScheduledTestResultsApi get_multi_test_filtered_http_server_scheduled_test_results POST /endpoint/test-results/scheduled-tests/http-server/filter Filter HTTP server scheduled test results
LocalNetworkEndpointTestResultsApi filter_local_networks_test_results_topologies POST /endpoint/test-results/local-networks/topologies/filter List endpoint network topologies probes
LocalNetworkEndpointTestResultsApi get_local_networks_test_results GET /endpoint/test-results/local-networks List local networks
LocalNetworkEndpointTestResultsApi get_local_networks_test_results_topology GET /endpoint/test-results/local-networks/topologies/{networkTopologyId} Retrieve endpoint local network topology
NetworkDynamicEndpointTestResultsApi filter_dynamic_test_network_results POST /endpoint/test-results/dynamic-tests/{testId}/network/filter Retrieve network dynamic test results
NetworkDynamicEndpointTestResultsApi get_dynamic_test_path_vis_agent_round_results GET /endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network dynamic test results details
NetworkDynamicEndpointTestResultsApi get_dynamic_test_path_vis_results GET /endpoint/test-results/dynamic-tests/{testId}/path-vis Retrieve path visualization network dynamic test results
NetworkEndpointScheduledTestResultsApi filter_scheduled_test_network_results POST /endpoint/test-results/scheduled-tests/{testId}/network/filter Retrieve network scheduled test results
NetworkEndpointScheduledTestResultsApi filter_scheduled_tests_network_results POST /endpoint/test-results/scheduled-tests/network/filter Retrieve network scheduled test results from multiple tests
NetworkEndpointScheduledTestResultsApi get_scheduled_test_path_vis_agent_round_results GET /endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network scheduled test results details
NetworkEndpointScheduledTestResultsApi get_scheduled_test_path_vis_results GET /endpoint/test-results/scheduled-tests/{testId}/path-vis Retrieve path visualization network scheduled test results
RealUserEndpointTestResultsApi filter_real_user_tests_network_results POST /endpoint/test-results/real-user-tests/networks/filter List endpoint real user tests
RealUserEndpointTestResultsApi filter_real_user_tests_results POST /endpoint/test-results/real-user-tests/filter List endpoint real user tests
RealUserEndpointTestResultsApi filter_real_user_tests_visited_pages_results POST /endpoint/test-results/real-user-tests/pages/filter List endpoint real user tests visited pages
RealUserEndpointTestResultsApi get_real_user_test_page_results GET /endpoint/test-results/real-user-tests/{id}/pages/{pageId} Retrieve endpoint real user test page
RealUserEndpointTestResultsApi get_real_user_test_results GET /endpoint/test-results/real-user-tests/{id} Retrieve endpoint real user test

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: Bearer authentication

Author

ThousandEyes API Team

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cisco-open from gravatar.com cisco-open

Unverified details

These details have not been verified by PyPI
Meta
  • License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR U...
  • Author: ThousandEyes API Team
  • Requires: Python >=3.8
  • Provides-Extra: dev , test

Release history Release notifications | RSS feed

3.0.0

2.26.0

2.25.0

2.24.0

2.23.0

2.22.0

2.21.0

2.20.0

2.19.0

2.18.0

2.17.0

2.16.0

2.15.0

2.14.0

2.13.0

2.12.0

2.11.0

2.10.0

2.9.0

2.8.0

2.7.0

2.6.0

2.5.0

2.4.0

2.2.0

2.1.0

2.0.1

This version

2.0.0

2.0.0rc1 pre-release

1.3.0

1.2.0

1.1.0

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thousandeyes_sdk_endpoint_test_results-2.0.0.tar.gz (140.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

thousandeyes_sdk_endpoint_test_results-2.0.0-py3-none-any.whl (257.8 kB view details)

Uploaded Python 3

File details

Details for the file thousandeyes_sdk_endpoint_test_results-2.0.0.tar.gz.

File metadata

File hashes

Hashes for thousandeyes_sdk_endpoint_test_results-2.0.0.tar.gz
Algorithm Hash digest
SHA256 bb8df846174fbed657a6563048af8c147352c11bb5ec540760df8883295d6dfb
MD5 43658c05cdd9c4bc8ee35f16f743bd77
BLAKE2b-256 204a2a6659da1775bcc280b4f2cf20b6213382555f5ca24c8070c3d074e8ed59

See more details on using hashes here.

File details

Details for the file thousandeyes_sdk_endpoint_test_results-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for thousandeyes_sdk_endpoint_test_results-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd5aa35c94d9a7c953beaf3ead0dbd0271b740923eb085e0bf33ed9131077df1
MD5 ebd49366620869cbb64ed8aa0d0a228d
BLAKE2b-256 1a7252f970a3cfd7b076b89419e7db55e0ec60a42eff87a620061c013689262b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page