# 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](https://openapi-generator.tech) project:

- API version: 7.0.8
- Generator version: 7.6.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:

```sh
pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-endpoint-test-results\&subdirectory=thousandeyes-sdk-endpoint-test-results
```
(you may need to run `pip` with root permission: `sudo pip install -e git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git#egg=thousandeyes-sdk-endpoint-test-results\&subdirectory=thousandeyes-sdk-endpoint-test-results`)

Then import the package:
```python
import thousandeyes_sdk.endpoint_test_results
```

### 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 thousandeyes_sdk.endpoint_test_results
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

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
# See configuration.py for a list of all supported configuration parameters.
configuration = thousandeyes_sdk.core.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 = 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.LocalNetworkTestsResultsApi(api_client)
    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)
    endpoint_network_topology_result_request = thousandeyes_sdk.endpoint_test_results.EndpointNetworkTopologyResultRequest() # EndpointNetworkTopologyResultRequest |  (optional)

    try:
        # List endpoint network topologies probes
        api_response = api_instance.filter_local_networks_test_results_topologies(aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, endpoint_network_topology_result_request=endpoint_network_topology_result_request)
        print("The response of LocalNetworkTestsResultsApi->filter_local_networks_test_results_topologies:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling LocalNetworkTestsResultsApi->filter_local_networks_test_results_topologies: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LocalNetworkTestsResultsApi* | [**filter_local_networks_test_results_topologies**](docs/LocalNetworkTestsResultsApi.md#filter_local_networks_test_results_topologies) | **POST** /v7/endpoint/test-results/local-networks/topologies/filter | List endpoint network topologies probes
*LocalNetworkTestsResultsApi* | [**get_local_networks_test_results**](docs/LocalNetworkTestsResultsApi.md#get_local_networks_test_results) | **GET** /v7/endpoint/test-results/local-networks | List local networks
*LocalNetworkTestsResultsApi* | [**get_local_networks_test_results_topology**](docs/LocalNetworkTestsResultsApi.md#get_local_networks_test_results_topology) | **GET** /v7/endpoint/test-results/local-networks/topologies/{networkTopologyId} | Retrieve endpoint local network topology
*NetworkDynamicTestsResultsApi* | [**filter_dynamic_test_network_results**](docs/NetworkDynamicTestsResultsApi.md#filter_dynamic_test_network_results) | **POST** /v7/endpoint/test-results/dynamic-tests/{testId}/network/filter | Retrieve network dynamic test results
*NetworkDynamicTestsResultsApi* | [**get_dynamic_test_path_vis_agent_round_results**](docs/NetworkDynamicTestsResultsApi.md#get_dynamic_test_path_vis_agent_round_results) | **GET** /v7/endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} | Retrieve path visualization network dynamic test results details
*NetworkDynamicTestsResultsApi* | [**get_dynamic_test_path_vis_results**](docs/NetworkDynamicTestsResultsApi.md#get_dynamic_test_path_vis_results) | **GET** /v7/endpoint/test-results/dynamic-tests/{testId}/path-vis | Retrieve path visualization network dynamic test results
*NetworkScheduledTestsResultsApi* | [**filter_scheduled_test_network_results**](docs/NetworkScheduledTestsResultsApi.md#filter_scheduled_test_network_results) | **POST** /v7/endpoint/test-results/scheduled-tests/{testId}/network/filter | Retrieve network scheduled test results
*NetworkScheduledTestsResultsApi* | [**filter_scheduled_tests_network_results**](docs/NetworkScheduledTestsResultsApi.md#filter_scheduled_tests_network_results) | **POST** /v7/endpoint/test-results/scheduled-tests/network/filter | Retrieve network scheduled test results from multiple tests
*NetworkScheduledTestsResultsApi* | [**get_scheduled_test_path_vis_agent_round_results**](docs/NetworkScheduledTestsResultsApi.md#get_scheduled_test_path_vis_agent_round_results) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} | Retrieve path visualization network scheduled test results details
*NetworkScheduledTestsResultsApi* | [**get_scheduled_test_path_vis_results**](docs/NetworkScheduledTestsResultsApi.md#get_scheduled_test_path_vis_results) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/path-vis | Retrieve path visualization network scheduled test results
*RealUserTestsResultsApi* | [**filter_real_user_tests_network_results**](docs/RealUserTestsResultsApi.md#filter_real_user_tests_network_results) | **POST** /v7/endpoint/test-results/real-user-tests/networks/filter | List endpoint real user tests
*RealUserTestsResultsApi* | [**filter_real_user_tests_results**](docs/RealUserTestsResultsApi.md#filter_real_user_tests_results) | **POST** /v7/endpoint/test-results/real-user-tests/filter | List endpoint real user tests
*RealUserTestsResultsApi* | [**filter_real_user_tests_visited_pages_results**](docs/RealUserTestsResultsApi.md#filter_real_user_tests_visited_pages_results) | **POST** /v7/endpoint/test-results/real-user-tests/pages/filter | List endpoint real user tests visited pages
*RealUserTestsResultsApi* | [**get_real_user_test_page_results**](docs/RealUserTestsResultsApi.md#get_real_user_test_page_results) | **GET** /v7/endpoint/test-results/real-user-tests/{id}/pages/{pageId} | Retrieve endpoint real user test page
*RealUserTestsResultsApi* | [**get_real_user_test_results**](docs/RealUserTestsResultsApi.md#get_real_user_test_results) | **GET** /v7/endpoint/test-results/real-user-tests/{id} | Retrieve endpoint real user test
*WebHTTPServerScheduledTestResultsApi* | [**get_http_server_scheduled_test_results**](docs/WebHTTPServerScheduledTestResultsApi.md#get_http_server_scheduled_test_results) | **GET** /v7/endpoint/test-results/scheduled-tests/{testId}/http-server | Retrieve HTTP server scheduled test results


## Documentation For Models

 - [AlertDirection](docs/AlertDirection.md)
 - [AlertRoundsViolationMode](docs/AlertRoundsViolationMode.md)
 - [AlertRule](docs/AlertRule.md)
 - [AlertType](docs/AlertType.md)
 - [ApplicationScoreQuality](docs/ApplicationScoreQuality.md)
 - [AsnDetails](docs/AsnDetails.md)
 - [ConditionalOperator](docs/ConditionalOperator.md)
 - [CpuUtilization](docs/CpuUtilization.md)
 - [DynamicBaseTestResult](docs/DynamicBaseTestResult.md)
 - [DynamicTest](docs/DynamicTest.md)
 - [DynamicTestLinks](docs/DynamicTestLinks.md)
 - [DynamicTestSelfLink](docs/DynamicTestSelfLink.md)
 - [DynamicTestWebex](docs/DynamicTestWebex.md)
 - [DynamicTestsDataRoundSearch](docs/DynamicTestsDataRoundSearch.md)
 - [DynamicTestsDataSearchFilter](docs/DynamicTestsDataSearchFilter.md)
 - [EndpointAgentLabelsSelectorConfig](docs/EndpointAgentLabelsSelectorConfig.md)
 - [EndpointAgentSelectorConfig](docs/EndpointAgentSelectorConfig.md)
 - [EndpointAgentToServerTest](docs/EndpointAgentToServerTest.md)
 - [EndpointAllAgentsSelectorConfig](docs/EndpointAllAgentsSelectorConfig.md)
 - [EndpointBrowser](docs/EndpointBrowser.md)
 - [EndpointHttpDataPointScore](docs/EndpointHttpDataPointScore.md)
 - [EndpointHttpServerBaseTest](docs/EndpointHttpServerBaseTest.md)
 - [EndpointHttpServerTest](docs/EndpointHttpServerTest.md)
 - [EndpointNetworkTopologyResultRequest](docs/EndpointNetworkTopologyResultRequest.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)
 - [EndpointRealUserTestResultsRequest](docs/EndpointRealUserTestResultsRequest.md)
 - [EndpointResultRequestFilter](docs/EndpointResultRequestFilter.md)
 - [EndpointScheduledTest](docs/EndpointScheduledTest.md)
 - [EndpointScheduledTestType](docs/EndpointScheduledTestType.md)
 - [EndpointSpecificAgentsSelectorConfig](docs/EndpointSpecificAgentsSelectorConfig.md)
 - [EndpointTest](docs/EndpointTest.md)
 - [EndpointTestAuthType](docs/EndpointTestAuthType.md)
 - [EndpointTestLinks](docs/EndpointTestLinks.md)
 - [EndpointTestProtocol](docs/EndpointTestProtocol.md)
 - [EndpointTestSelfLink](docs/EndpointTestSelfLink.md)
 - [Error](docs/Error.md)
 - [EthernetProfile](docs/EthernetProfile.md)
 - [Expand](docs/Expand.md)
 - [GatewayNetworkPing](docs/GatewayNetworkPing.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)
 - [NetworkProxy](docs/NetworkProxy.md)
 - [NetworkProxyProfile](docs/NetworkProxyProfile.md)
 - [NetworkTestResult](docs/NetworkTestResult.md)
 - [NetworkTestResults](docs/NetworkTestResults.md)
 - [NetworkTopologyType](docs/NetworkTopologyType.md)
 - [NetworkWirelessProfile](docs/NetworkWirelessProfile.md)
 - [PaginationNextAndSelfLink](docs/PaginationNextAndSelfLink.md)
 - [PaginationNextLink](docs/PaginationNextLink.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)
 - [RealUserTestCoordinates](docs/RealUserTestCoordinates.md)
 - [RealUserTestNetwork](docs/RealUserTestNetwork.md)
 - [RealUserTestNetworkResult](docs/RealUserTestNetworkResult.md)
 - [RealUserTestNetworkResults](docs/RealUserTestNetworkResults.md)
 - [RealUserTestPage](docs/RealUserTestPage.md)
 - [RealUserTestPageDetailResult](docs/RealUserTestPageDetailResult.md)
 - [RealUserTestPageResult](docs/RealUserTestPageResult.md)
 - [RealUserTestPageResults](docs/RealUserTestPageResults.md)
 - [RealUserTestPageTimings](docs/RealUserTestPageTimings.md)
 - [SelfLinks](docs/SelfLinks.md)
 - [Severity](docs/Severity.md)
 - [SortOrder](docs/SortOrder.md)
 - [SystemMetrics](docs/SystemMetrics.md)
 - [TargetNetworkPing](docs/TargetNetworkPing.md)
 - [TargetProfile](docs/TargetProfile.md)
 - [TargetTraceroute](docs/TargetTraceroute.md)
 - [TcpConnect](docs/TcpConnect.md)
 - [TestInterval](docs/TestInterval.md)
 - [TestLabel](docs/TestLabel.md)
 - [TestProbeModeResponse](docs/TestProbeModeResponse.md)
 - [TestProtocol](docs/TestProtocol.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)
 - [UdpProbeModeResponse](docs/UdpProbeModeResponse.md)
 - [UnauthorizedError](docs/UnauthorizedError.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorItem](docs/ValidationErrorItem.md)
 - [VpnNetworkPing](docs/VpnNetworkPing.md)
 - [VpnProfile](docs/VpnProfile.md)
 - [VpnTraceroute](docs/VpnTraceroute.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