# test-results-api
Retrieve results for scheduled and dynamic tests on endpoint agents.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:

```sh
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:
```python
import test_results_api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import test_results_api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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


# Enter a context with an instance of the API client
with test_results_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = test_results_api.LocalNetworkTestsResultsApi(api_client)
    network_topology_id = '00160:39c518560de9:1491651900:236e6f18' # str | The network topology ID.
    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:
        # 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**](docs/LocalNetworkTestsResultsApi.md#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**](docs/LocalNetworkTestsResultsApi.md#get_endpoint_local_networks) | **GET** /v7/endpoint/test-results/local-networks | List local networks
*LocalNetworkTestsResultsApi* | [**get_endpoint_local_networks_topologies**](docs/LocalNetworkTestsResultsApi.md#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**](docs/NetworkDynamicTestsResultsApi.md#get_dynamic_test_result_network_pathvis) | **GET** /v7/endpoint/test-results/dynamic-tests/{testId}/pathvis | Retrieve pathvis network dynamic test results
*NetworkDynamicTestsResultsApi* | [**get_dynamic_test_result_pathvis_agent_round**](docs/NetworkDynamicTestsResultsApi.md#get_dynamic_test_result_pathvis_agent_round) | **GET** /v7/endpoint/test-results/dynamic-tests/{testId}/pathvis/agent/{agentId}/round/{roundId} | Retrieve pathvis network dynamic test results details
*NetworkDynamicTestsResultsApi* | [**post_fetch_dynamic_test_result_metrics**](docs/NetworkDynamicTestsResultsApi.md#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**](docs/NetworkScheduledTestsResultsApi.md#get_test_result_network_pathvis) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/pathvis | Retrieve pathvis network scheduled test results
*NetworkScheduledTestsResultsApi* | [**get_test_result_pathvis_agent_round**](docs/NetworkScheduledTestsResultsApi.md#get_test_result_pathvis_agent_round) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/pathvis/agent/{agentId}/round/{roundId} | Retrieve pathvis network scheduled test results details
*NetworkScheduledTestsResultsApi* | [**post_fetch_test_result_metrics**](docs/NetworkScheduledTestsResultsApi.md#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**](docs/NetworkScheduledTestsResultsApi.md#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**](docs/RealUserTestsResultsApi.md#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**](docs/RealUserTestsResultsApi.md#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**](docs/RealUserTestsResultsApi.md#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**](docs/RealUserTestsResultsApi.md#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**](docs/RealUserTestsResultsApi.md#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**](docs/WebHTTPServerScheduledTestResultsApi.md#get_test_result_http_server) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/http-server | Retrieve HTTP server scheduled test results


## Documentation For Models

 - [AccountGroupId](docs/AccountGroupId.md)
 - [AgentLabelsSelectorType](docs/AgentLabelsSelectorType.md)
 - [AllAgentsSelectorType](docs/AllAgentsSelectorType.md)
 - [ApplicationScoreQuality](docs/ApplicationScoreQuality.md)
 - [AsnDetails](docs/AsnDetails.md)
 - [ConditionalOperator](docs/ConditionalOperator.md)
 - [CpuUtilization](docs/CpuUtilization.md)
 - [DynamicBaseTestResult](docs/DynamicBaseTestResult.md)
 - [DynamicBaseTestResultWebex](docs/DynamicBaseTestResultWebex.md)
 - [DynamicTest](docs/DynamicTest.md)
 - [DynamicTestApplication](docs/DynamicTestApplication.md)
 - [DynamicTestLinks](docs/DynamicTestLinks.md)
 - [DynamicTestLinksSelf](docs/DynamicTestLinksSelf.md)
 - [DynamicTestLinksTestResults](docs/DynamicTestLinksTestResults.md)
 - [DynamicTestsDataRoundSearch](docs/DynamicTestsDataRoundSearch.md)
 - [DynamicTestsDataSearchFilter](docs/DynamicTestsDataSearchFilter.md)
 - [EndpointAgentLabelsSelectorConfig](docs/EndpointAgentLabelsSelectorConfig.md)
 - [EndpointAgentSelectorConfig](docs/EndpointAgentSelectorConfig.md)
 - [EndpointAgentToServerTest](docs/EndpointAgentToServerTest.md)
 - [EndpointAgentToServerType](docs/EndpointAgentToServerType.md)
 - [EndpointAllAgentsSelectorConfig](docs/EndpointAllAgentsSelectorConfig.md)
 - [EndpointBrowser](docs/EndpointBrowser.md)
 - [EndpointHttpDataPointScore](docs/EndpointHttpDataPointScore.md)
 - [EndpointHttpServerBaseTest](docs/EndpointHttpServerBaseTest.md)
 - [EndpointHttpServerTest](docs/EndpointHttpServerTest.md)
 - [EndpointHttpServerType](docs/EndpointHttpServerType.md)
 - [EndpointNetworkTopologyResultRequestFilter](docs/EndpointNetworkTopologyResultRequestFilter.md)
 - [EndpointPingDataPointScore](docs/EndpointPingDataPointScore.md)
 - [EndpointRealUserTest](docs/EndpointRealUserTest.md)
 - [EndpointRealUserTestBase](docs/EndpointRealUserTestBase.md)
 - [EndpointRealUserTestDetail](docs/EndpointRealUserTestDetail.md)
 - [EndpointRealUserTestDetailResults](docs/EndpointRealUserTestDetailResults.md)
 - [EndpointRealUserTestResultRequestFilter](docs/EndpointRealUserTestResultRequestFilter.md)
 - [EndpointRealUserTestResults](docs/EndpointRealUserTestResults.md)
 - [EndpointResultRequestFilter](docs/EndpointResultRequestFilter.md)
 - [EndpointScheduledTest](docs/EndpointScheduledTest.md)
 - [EndpointScheduledTestType](docs/EndpointScheduledTestType.md)
 - [EndpointSpecificAgentsSelectorConfig](docs/EndpointSpecificAgentsSelectorConfig.md)
 - [EndpointTest](docs/EndpointTest.md)
 - [EndpointTestAid](docs/EndpointTestAid.md)
 - [EndpointTestAuthType](docs/EndpointTestAuthType.md)
 - [EndpointTestLinks](docs/EndpointTestLinks.md)
 - [EndpointTestLinksSelf](docs/EndpointTestLinksSelf.md)
 - [EndpointTestLinksTestResults](docs/EndpointTestLinksTestResults.md)
 - [EndpointTestProtocol](docs/EndpointTestProtocol.md)
 - [Error](docs/Error.md)
 - [EthernetProfile](docs/EthernetProfile.md)
 - [Expand](docs/Expand.md)
 - [GetDynamicTestResultNetworkPathvis200Response](docs/GetDynamicTestResultNetworkPathvis200Response.md)
 - [GetDynamicTestResultPathvisAgentRound200Response](docs/GetDynamicTestResultPathvisAgentRound200Response.md)
 - [GetEndpointLocalNetworkTopologyDetails200Response](docs/GetEndpointLocalNetworkTopologyDetails200Response.md)
 - [GetEndpointLocalNetworks200Response](docs/GetEndpointLocalNetworks200Response.md)
 - [GetEndpointLocalNetworksTopologies200Response](docs/GetEndpointLocalNetworksTopologies200Response.md)
 - [GetEndpointLocalNetworksTopologiesRequest](docs/GetEndpointLocalNetworksTopologiesRequest.md)
 - [GetEndpointRealUserTestDetails200Response](docs/GetEndpointRealUserTestDetails200Response.md)
 - [GetEndpointRealUserTestPagesDetails200Response](docs/GetEndpointRealUserTestPagesDetails200Response.md)
 - [GetEndpointRealUserTests200Response](docs/GetEndpointRealUserTests200Response.md)
 - [GetEndpointRealUserTestsNetwork200Response](docs/GetEndpointRealUserTestsNetwork200Response.md)
 - [GetEndpointRealUserTestsPages200Response](docs/GetEndpointRealUserTestsPages200Response.md)
 - [GetEndpointRealUserTestsRequest](docs/GetEndpointRealUserTestsRequest.md)
 - [GetTestResultHttpServer200Response](docs/GetTestResultHttpServer200Response.md)
 - [GetTestResultNetworkPathvis200Response](docs/GetTestResultNetworkPathvis200Response.md)
 - [GetTestResultPathvisAgentRound200Response](docs/GetTestResultPathvisAgentRound200Response.md)
 - [Hop](docs/Hop.md)
 - [HttpErrorType](docs/HttpErrorType.md)
 - [HttpTestResult](docs/HttpTestResult.md)
 - [HttpTestResultHeaders](docs/HttpTestResultHeaders.md)
 - [HttpTestResults](docs/HttpTestResults.md)
 - [InterfaceHardwareType](docs/InterfaceHardwareType.md)
 - [Link](docs/Link.md)
 - [LocalNetworkResult](docs/LocalNetworkResult.md)
 - [LocalNetworkResults](docs/LocalNetworkResults.md)
 - [LocalNetworkTopologyDetailResults](docs/LocalNetworkTopologyDetailResults.md)
 - [LocalNetworkTopologyResult](docs/LocalNetworkTopologyResult.md)
 - [LocalNetworkTopologyResultBase](docs/LocalNetworkTopologyResultBase.md)
 - [LocalNetworkTopologyResults](docs/LocalNetworkTopologyResults.md)
 - [MultiTestIdNetworkTestResults](docs/MultiTestIdNetworkTestResults.md)
 - [MultiTestIdTestsDataRoundsSearch](docs/MultiTestIdTestsDataRoundsSearch.md)
 - [MultiTestIdTestsDataSearchFilter](docs/MultiTestIdTestsDataSearchFilter.md)
 - [NetworkDynamicTestResult](docs/NetworkDynamicTestResult.md)
 - [NetworkDynamicTestResults](docs/NetworkDynamicTestResults.md)
 - [NetworkInterface](docs/NetworkInterface.md)
 - [NetworkMetrics](docs/NetworkMetrics.md)
 - [NetworkPing](docs/NetworkPing.md)
 - [NetworkProfile](docs/NetworkProfile.md)
 - [NetworkProxyProfile](docs/NetworkProxyProfile.md)
 - [NetworkProxyProfileProxiesInner](docs/NetworkProxyProfileProxiesInner.md)
 - [NetworkTestResult](docs/NetworkTestResult.md)
 - [NetworkTestResults](docs/NetworkTestResults.md)
 - [NetworkTopologyType](docs/NetworkTopologyType.md)
 - [NetworkWirelessProfile](docs/NetworkWirelessProfile.md)
 - [PaginationNextLink](docs/PaginationNextLink.md)
 - [PaginationNextLinkLinks](docs/PaginationNextLinkLinks.md)
 - [PathVisBaseTestResult](docs/PathVisBaseTestResult.md)
 - [PathVisDetailDynamicTestResult](docs/PathVisDetailDynamicTestResult.md)
 - [PathVisDetailDynamicTestResults](docs/PathVisDetailDynamicTestResults.md)
 - [PathVisDetailTestResult](docs/PathVisDetailTestResult.md)
 - [PathVisDetailTestResults](docs/PathVisDetailTestResults.md)
 - [PathVisDynamicTestResult](docs/PathVisDynamicTestResult.md)
 - [PathVisDynamicTestResults](docs/PathVisDynamicTestResults.md)
 - [PathVisEndpoint](docs/PathVisEndpoint.md)
 - [PathVisHop](docs/PathVisHop.md)
 - [PathVisRoute](docs/PathVisRoute.md)
 - [PathVisTestResult](docs/PathVisTestResult.md)
 - [PathVisTestResults](docs/PathVisTestResults.md)
 - [PhysicalMemoryUsedBytes](docs/PhysicalMemoryUsedBytes.md)
 - [Platform](docs/Platform.md)
 - [PostFetchDynamicTestResultMetrics200Response](docs/PostFetchDynamicTestResultMetrics200Response.md)
 - [PostFetchTestResultMetrics200Response](docs/PostFetchTestResultMetrics200Response.md)
 - [PostFetchTestResultMetricsMultiTest200Response](docs/PostFetchTestResultMetricsMultiTest200Response.md)
 - [QueryWindow](docs/QueryWindow.md)
 - [RealUserTestCoordinates](docs/RealUserTestCoordinates.md)
 - [RealUserTestNetwork](docs/RealUserTestNetwork.md)
 - [RealUserTestNetworkGatewayPing](docs/RealUserTestNetworkGatewayPing.md)
 - [RealUserTestNetworkPing](docs/RealUserTestNetworkPing.md)
 - [RealUserTestNetworkResult](docs/RealUserTestNetworkResult.md)
 - [RealUserTestNetworkResults](docs/RealUserTestNetworkResults.md)
 - [RealUserTestNetworkTraceroute](docs/RealUserTestNetworkTraceroute.md)
 - [RealUserTestNetworkVpnPing](docs/RealUserTestNetworkVpnPing.md)
 - [RealUserTestNetworkVpnTraceroute](docs/RealUserTestNetworkVpnTraceroute.md)
 - [RealUserTestPage](docs/RealUserTestPage.md)
 - [RealUserTestPagePageTimings](docs/RealUserTestPagePageTimings.md)
 - [RealUserTestPageResult](docs/RealUserTestPageResult.md)
 - [RealUserTestPageResults](docs/RealUserTestPageResults.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [SelfLinksLinks](docs/SelfLinksLinks.md)
 - [SortOrder](docs/SortOrder.md)
 - [SpecificAgentsSelectorType](docs/SpecificAgentsSelectorType.md)
 - [SystemMetrics](docs/SystemMetrics.md)
 - [TcpConnect](docs/TcpConnect.md)
 - [TestInterval](docs/TestInterval.md)
 - [TestProbeMode](docs/TestProbeMode.md)
 - [TestResult](docs/TestResult.md)
 - [TestSslVersionId](docs/TestSslVersionId.md)
 - [TestsDataRoundsSearch](docs/TestsDataRoundsSearch.md)
 - [TestsDataSearchFilter](docs/TestsDataSearchFilter.md)
 - [TestsDataSearchSort](docs/TestsDataSearchSort.md)
 - [TestsDataSearchSortKey](docs/TestsDataSearchSortKey.md)
 - [TestsDataThresholdFilter](docs/TestsDataThresholdFilter.md)
 - [TestsDataThresholdFilters](docs/TestsDataThresholdFilters.md)
 - [ThresholdFilterName](docs/ThresholdFilterName.md)
 - [ThresholdFilterOperator](docs/ThresholdFilterOperator.md)
 - [Traceroute](docs/Traceroute.md)
 - [TracerouteHop](docs/TracerouteHop.md)
 - [Trigger](docs/Trigger.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [VpnProfile](docs/VpnProfile.md)
 - [VpnType](docs/VpnType.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="BearerAuth"></a>
### BearerAuth

- **Type**: Bearer authentication


## Author




