Skip to content

Latest commit

 

History

History
196 lines (145 loc) · 13.3 KB

README.md

File metadata and controls

196 lines (145 loc) · 13.3 KB
Raw

test-results

Test Results API

  • API version: 7.0.21

Get test result metrics for Cloud and Enterprise Agent tests.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 11+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependencies>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>test-results</artifactId>
        <version>version</version>
    </dependency>
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client</artifactId>
        <version>version</version>
    </dependency>

    <!-- Example only, you can use your own client implementation -->
    <dependency>
        <groupId>com.thousandeyes.sdk</groupId>
        <artifactId>client-native</artifactId>
        <version>version</version>
    </dependency>
</dependencies>

Gradle users

Add this dependency to your project's build file:

implementation "com.thousandeyes.sdk:client:<version>"
implementation "com.thousandeyes.sdk:client-native:<version>" #Example only, you can use your own client implementation
implementation "com.thousandeyes.sdk:test-results:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/test-results-version.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.thousandeyes.sdk.tests.*;
import com.thousandeyes.sdk.tests.client.*;
import com.thousandeyes.sdk.tests.results.model.*;
import com.thousandeyes.sdk.tests.results.ApiTestResultsApi;

public class ApiTestResultsApiExample {

    public static void main(String[] args) {
        // Configure clients using the `defaultClient` object, such as
        // overriding the host and port, timeout, etc. In this example we are using the NativeApiClient
        // but you can use your own client implementation
        ApiClient defaultClient = NativeApiClient
                .builder()
                .baseUri("https://api.thousandeyes.com/v7")
                .bearerToken("<bearer-token>")
                .build();

        ApiTestResultsApi apiInstance = new ApiTestResultsApi(defaultClient);
        String testId = "202701"; // String | Test ID
        String agentId = "11"; // String | Agent ID
        String roundId = "1384309800"; // String | Round ID
        String aid = "1234"; // String | 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.
        try {
            ApiDetailTestResults result = apiInstance.getTestApiAgentRoundResults(testId, agentId, roundId, aid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiTestResultsApi#getTestApiAgentRoundResults");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
ApiTestResultsApi getTestApiAgentRoundResults GET /test-results/{testId}/api/agent/{agentId}/round/{roundId} Get API test results by agent and round
ApiTestResultsApi getTestApiAgentRoundResultsWithHttpInfo GET /test-results/{testId}/api/agent/{agentId}/round/{roundId} Get API test results by agent and round
ApiTestResultsApi getTestApiResults GET /test-results/{testId}/api Get API test results
ApiTestResultsApi getTestApiResultsWithHttpInfo GET /test-results/{testId}/api Get API test results
DnsServerTestResultsApi getTestDnsServerResult GET /test-results/{testId}/dns-server/{serverId} Get DNS server test results by server
DnsServerTestResultsApi getTestDnsServerResultWithHttpInfo GET /test-results/{testId}/dns-server/{serverId} Get DNS server test results by server
DnsServerTestResultsApi getTestDnsServersResults GET /test-results/{testId}/dns-server Get DNS server test results
DnsServerTestResultsApi getTestDnsServersResultsWithHttpInfo GET /test-results/{testId}/dns-server Get DNS server test results
DnsTraceTestResultsApi getTestDnsTraceResults GET /test-results/{testId}/dns-trace Get DNS trace test results
DnsTraceTestResultsApi getTestDnsTraceResultsWithHttpInfo GET /test-results/{testId}/dns-trace Get DNS trace test results
DnssecTestResultsApi getTestDnsSecResults GET /test-results/{testId}/dnssec Get DNSSEC test results
DnssecTestResultsApi getTestDnsSecResultsWithHttpInfo GET /test-results/{testId}/dnssec Get DNSSEC test results
NetworkBgpTestResultsApi getTestBgpResults GET /test-results/{testId}/bgp Get BGP test results
NetworkBgpTestResultsApi getTestBgpResultsWithHttpInfo GET /test-results/{testId}/bgp Get BGP test results
NetworkBgpTestResultsApi getTestBgpRoutesPrefixRoundResults GET /test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId} Get BGP route test results by prefix
NetworkBgpTestResultsApi getTestBgpRoutesPrefixRoundResultsWithHttpInfo GET /test-results/{testId}/bgp/routes/prefix/{prefixId}/round/{roundId} Get BGP route test results by prefix
NetworkTestResultsApi getTestNetworkResults GET /test-results/{testId}/network Get network test results
NetworkTestResultsApi getTestNetworkResultsWithHttpInfo GET /test-results/{testId}/network Get network test results
NetworkTestResultsApi getTestPathVisAgentRoundResults GET /test-results/{testId}/path-vis/agent/{agentId}/round/{roundId} Get path visualization test results by agent and round
NetworkTestResultsApi getTestPathVisAgentRoundResultsWithHttpInfo GET /test-results/{testId}/path-vis/agent/{agentId}/round/{roundId} Get path visualization test results by agent and round
NetworkTestResultsApi getTestPathVisResults GET /test-results/{testId}/path-vis Get path visualization network test results
NetworkTestResultsApi getTestPathVisResultsWithHttpInfo GET /test-results/{testId}/path-vis Get path visualization network test results
VoiceRtpServerTestResultsApi getTestRtpServerResults GET /test-results/{testId}/rtp-server Retrieve RTP server test metrics
VoiceRtpServerTestResultsApi getTestRtpServerResultsWithHttpInfo GET /test-results/{testId}/rtp-server Retrieve RTP server test metrics
VoiceSipServerTestResultsApi getTestSipServerResults GET /test-results/{testId}/sip-server Get SIP server test results
VoiceSipServerTestResultsApi getTestSipServerResultsWithHttpInfo GET /test-results/{testId}/sip-server Get SIP server test results
WebFtpServerTestResultsApi getTestFtpServerResults GET /test-results/{testId}/ftp-server Get FTP server test results
WebFtpServerTestResultsApi getTestFtpServerResultsWithHttpInfo GET /test-results/{testId}/ftp-server Get FTP server test results
WebHttpServerTestResultsApi getTestHttpServerResults GET /test-results/{testId}/http-server Get HTTP server test results
WebHttpServerTestResultsApi getTestHttpServerResultsWithHttpInfo GET /test-results/{testId}/http-server Get HTTP server test results
WebPageLoadTestResultsApi getTestPageLoadAgentRoundResults GET /test-results/{testId}/page-load/agent/{agentId}/round/{roundId} Get page load server test results by agent and round
WebPageLoadTestResultsApi getTestPageLoadAgentRoundResultsWithHttpInfo GET /test-results/{testId}/page-load/agent/{agentId}/round/{roundId} Get page load server test results by agent and round
WebPageLoadTestResultsApi getTestPageLoadResults GET /test-results/{testId}/page-load Get page load server test results
WebPageLoadTestResultsApi getTestPageLoadResultsWithHttpInfo GET /test-results/{testId}/page-load Get page load server test results
WebTransactionsTestResultsApi getTestWebTransactionAgentRoundPageResults GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId} Get detailed web transactions test result by agent, round, and page
WebTransactionsTestResultsApi getTestWebTransactionAgentRoundPageResultsWithHttpInfo GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId} Get detailed web transactions test result by agent, round, and page
WebTransactionsTestResultsApi getTestWebTransactionAgentRoundResults GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId} Get web transactions test results by agent and round
WebTransactionsTestResultsApi getTestWebTransactionAgentRoundResultsWithHttpInfo GET /test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId} Get web transactions test results by agent and round
WebTransactionsTestResultsApi getTestWebTransactionResults GET /test-results/{testId}/web-transactions Get web transactions test results
WebTransactionsTestResultsApi getTestWebTransactionResultsWithHttpInfo GET /test-results/{testId}/web-transactions Get web transactions test results

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author