gitea-admin/thousandeyes-sdk-python
1
0
Fork 0
mirror of https://github.com/thousandeyes/thousandeyes-sdk-python.git synced 2025-12-06 16:05:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ef41278fcd
thousandeyes-sdk-python/test_results/README.md
Shahid Hussain Khan ef41278fcd CP-2060 Fix user-agent
2024-05-02 16:26:53 +01:00

229 lines
13 KiB
Markdown
Raw Blame History

# test-results
Get test result metrics for Cloud and Enterprise Agent tests.
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
- 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:
```sh
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:
```python
import 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 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 test_results
from 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 = 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 = test_results.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with test_results.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = test_results.DNSSECTestMetricsApi(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)
try:
# Get DNSSEC test results
api_response = api_instance.get_test_result_dnssec(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor)
print("The response of DNSSECTestMetricsApi->get_test_result_dnssec:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DNSSECTestMetricsApi->get_test_result_dnssec: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.thousandeyes.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DNSSECTestMetricsApi* | [**get_test_result_dnssec**](docs/DNSSECTestMetricsApi.md#get_test_result_dnssec) | **GET** /v7/test-results/{testId}/dnssec | Get DNSSEC test results
*DNSServerTestMetricsApi* | [**get_test_result_dns_server**](docs/DNSServerTestMetricsApi.md#get_test_result_dns_server) | **GET** /v7/test-results/{testId}/dns-server/{serverId} | Get DNS server test results by server
*DNSServerTestMetricsApi* | [**get_test_result_dns_servers**](docs/DNSServerTestMetricsApi.md#get_test_result_dns_servers) | **GET** /v7/test-results/{testId}/dns-server | Get DNS server test results
*DNSTraceTestMetricsApi* | [**get_test_result_dns_trace**](docs/DNSTraceTestMetricsApi.md#get_test_result_dns_trace) | **GET** /v7/test-results/{testId}/dns-trace | Get DNS trace test results
*NetworkBGPTestMetricsApi* | [**get_test_results_bgp**](docs/NetworkBGPTestMetricsApi.md#get_test_results_bgp) | **GET** /v7/test-results/{testId}/bgp | Get BGP test results
*NetworkBGPTestMetricsApi* | [**get_test_results_bgp_prefix**](docs/NetworkBGPTestMetricsApi.md#get_test_results_bgp_prefix) | **GET** /v7/test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId} | Get BGP route test results by prefix
*NetworkTestMetricsApi* | [**get_test_pathvis_agent_round**](docs/NetworkTestMetricsApi.md#get_test_pathvis_agent_round) | **GET** /v7/test-results/{testId}/path-vis/agent/{agentId}/round/{roundId} | Get path visualization test results by agent and round
*NetworkTestMetricsApi* | [**get_test_result_metrics**](docs/NetworkTestMetricsApi.md#get_test_result_metrics) | **GET** /v7/test-results/{testId}/network | Get network test results
*NetworkTestMetricsApi* | [**get_test_result_network_path_vis**](docs/NetworkTestMetricsApi.md#get_test_result_network_path_vis) | **GET** /v7/test-results/{testId}/path-vis | Get path visualization network test results
*VoiceRTPServerTestMetricsApi* | [**get_test_result_rtp_stream**](docs/VoiceRTPServerTestMetricsApi.md#get_test_result_rtp_stream) | **GET** /v7/test-results/{testId}/rtp-server | Retrieve RTP server test metrics
*VoiceSIPServerTestMetricsApi* | [**get_test_result_sip_server**](docs/VoiceSIPServerTestMetricsApi.md#get_test_result_sip_server) | **GET** /v7/test-results/{testId}/sip-server | Get SIP server test results
*WebFTPServerTestMetricsApi* | [**get_test_result_ftp_server**](docs/WebFTPServerTestMetricsApi.md#get_test_result_ftp_server) | **GET** /v7/test-results/{testId}/ftp-server | Get FTP server test results
*WebHTTPServerTestMetricsApi* | [**get_test_result_http_server**](docs/WebHTTPServerTestMetricsApi.md#get_test_result_http_server) | **GET** /v7/test-results/{testId}/http-server | Get HTTP server test results
*WebPageLoadTestMetricsApi* | [**get_test_result_page_load**](docs/WebPageLoadTestMetricsApi.md#get_test_result_page_load) | **GET** /v7/test-results/{testId}/page-load | Get page load server test results
*WebPageLoadTestMetricsApi* | [**get_test_result_page_load_component_detail**](docs/WebPageLoadTestMetricsApi.md#get_test_result_page_load_component_detail) | **GET** /v7/test-results/{testId}/page-load/agent/{agentId}/round/{roundId} | Get page load server test results by agent and round
*WebTransactionsTestMetricsApi* | [**get_test_result_web_transactions**](docs/WebTransactionsTestMetricsApi.md#get_test_result_web_transactions) | **GET** /v7/test-results/{testId}/web-transactions | Get web transactions test results
*WebTransactionsTestMetricsApi* | [**get_test_result_web_transactions_component_detail**](docs/WebTransactionsTestMetricsApi.md#get_test_result_web_transactions_component_detail) | **GET** /v7/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId} | Get web transactions test results by agent and round
*WebTransactionsTestMetricsApi* | [**get_test_result_web_transactions_component_page_detail**](docs/WebTransactionsTestMetricsApi.md#get_test_result_web_transactions_component_page_detail) | **GET** /v7/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId} | Get detailed web transactions test result by agent, round, and page
## Documentation For Models
- [Agent](docs/Agent.md)
- [AppLinks](docs/AppLinks.md)
- [AppLinksLinks](docs/AppLinksLinks.md)
- [BgpBasicTestResult](docs/BgpBasicTestResult.md)
- [BgpHop](docs/BgpHop.md)
- [BgpTestResult](docs/BgpTestResult.md)
- [BgpTestResults](docs/BgpTestResults.md)
- [BgpTestRouteInformationResult](docs/BgpTestRouteInformationResult.md)
- [BgpTestRouteInformationResults](docs/BgpTestRouteInformationResults.md)
- [DnsServerTestResult](docs/DnsServerTestResult.md)
- [DnsServerTestResults](docs/DnsServerTestResults.md)
- [DnsTraceTestResult](docs/DnsTraceTestResult.md)
- [DnsTraceTestResults](docs/DnsTraceTestResults.md)
- [DnssecTestResult](docs/DnssecTestResult.md)
- [DnssecTestResults](docs/DnssecTestResults.md)
- [EpochTimeWindow](docs/EpochTimeWindow.md)
- [Error](docs/Error.md)
- [Expand](docs/Expand.md)
- [FtpServerTestResult](docs/FtpServerTestResult.md)
- [FtpServerTestResults](docs/FtpServerTestResults.md)
- [GetTestPathvisAgentRound200Response](docs/GetTestPathvisAgentRound200Response.md)
- [GetTestResultDnsServer200Response](docs/GetTestResultDnsServer200Response.md)
- [GetTestResultDnsTrace200Response](docs/GetTestResultDnsTrace200Response.md)
- [GetTestResultDnssec200Response](docs/GetTestResultDnssec200Response.md)
- [GetTestResultFtpServer200Response](docs/GetTestResultFtpServer200Response.md)
- [GetTestResultHttpServer200Response](docs/GetTestResultHttpServer200Response.md)
- [GetTestResultMetrics200Response](docs/GetTestResultMetrics200Response.md)
- [GetTestResultNetworkPathVis200Response](docs/GetTestResultNetworkPathVis200Response.md)
- [GetTestResultPageLoad200Response](docs/GetTestResultPageLoad200Response.md)
- [GetTestResultPageLoadComponentDetail200Response](docs/GetTestResultPageLoadComponentDetail200Response.md)
- [GetTestResultRtpStream200Response](docs/GetTestResultRtpStream200Response.md)
- [GetTestResultSipServer200Response](docs/GetTestResultSipServer200Response.md)
- [GetTestResultWebTransactions200Response](docs/GetTestResultWebTransactions200Response.md)
- [GetTestResultWebTransactionsComponentDetail200Response](docs/GetTestResultWebTransactionsComponentDetail200Response.md)
- [GetTestResultWebTransactionsComponentPageDetail200Response](docs/GetTestResultWebTransactionsComponentPageDetail200Response.md)
- [GetTestResultsBgp200Response](docs/GetTestResultsBgp200Response.md)
- [GetTestResultsBgpPrefix200Response](docs/GetTestResultsBgpPrefix200Response.md)
- [HttpTestResult](docs/HttpTestResult.md)
- [HttpTestResultHeaders](docs/HttpTestResultHeaders.md)
- [HttpTestResults](docs/HttpTestResults.md)
- [Link](docs/Link.md)
- [Marker](docs/Marker.md)
- [Monitor](docs/Monitor.md)
- [NetworkTestResult](docs/NetworkTestResult.md)
- [NetworkTestResults](docs/NetworkTestResults.md)
- [Page](docs/Page.md)
- [PageLoadDetailTestResult](docs/PageLoadDetailTestResult.md)
- [PageLoadDetailTestResults](docs/PageLoadDetailTestResults.md)
- [PageLoadTestResult](docs/PageLoadTestResult.md)
- [PageLoadTestResults](docs/PageLoadTestResults.md)
- [PaginationLinks](docs/PaginationLinks.md)
- [PaginationLinksLinks](docs/PaginationLinksLinks.md)
- [PathVisBaseTestResult](docs/PathVisBaseTestResult.md)
- [PathVisDetailTestResult](docs/PathVisDetailTestResult.md)
- [PathVisDetailTestResults](docs/PathVisDetailTestResults.md)
- [PathVisDirection](docs/PathVisDirection.md)
- [PathVisEndpoint](docs/PathVisEndpoint.md)
- [PathVisHop](docs/PathVisHop.md)
- [PathVisRoute](docs/PathVisRoute.md)
- [PathVisTestResult](docs/PathVisTestResult.md)
- [PathVisTestResults](docs/PathVisTestResults.md)
- [QueryWindow](docs/QueryWindow.md)
- [RtpStreamTestResult](docs/RtpStreamTestResult.md)
- [RtpStreamTestResults](docs/RtpStreamTestResults.md)
- [SelfLinks](docs/SelfLinks.md)
- [SelfLinksLinks](docs/SelfLinksLinks.md)
- [SimpleTest](docs/SimpleTest.md)
- [SimpleTestLinks](docs/SimpleTestLinks.md)
- [SimpleTestLinksSelf](docs/SimpleTestLinksSelf.md)
- [SipServerErrorType](docs/SipServerErrorType.md)
- [SipServerTestResult](docs/SipServerTestResult.md)
- [SipServerTestResults](docs/SipServerTestResults.md)
- [SslCert](docs/SslCert.md)
- [TestDirection](docs/TestDirection.md)
- [TestInterval](docs/TestInterval.md)
- [TestResult](docs/TestResult.md)
- [TestResultAppLinks](docs/TestResultAppLinks.md)
- [TestType](docs/TestType.md)
- [UnauthorizedError](docs/UnauthorizedError.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorAllOfErrors](docs/ValidationErrorAllOfErrors.md)
- [WebTransactionDetailTestResult](docs/WebTransactionDetailTestResult.md)
- [WebTransactionDetailTestResults](docs/WebTransactionDetailTestResults.md)
- [WebTransactionPageDetailTestResult](docs/WebTransactionPageDetailTestResult.md)
- [WebTransactionPageDetailTestResults](docs/WebTransactionPageDetailTestResults.md)
- [WebTransactionTestResult](docs/WebTransactionTestResult.md)
- [WebTransactionTestResults](docs/WebTransactionTestResults.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
Reference in New Issue View Git Blame Copy Permalink