Skip to content

Latest commit

 

History

History
193 lines (142 loc) · 15.7 KB

README.md

File metadata and controls

193 lines (142 loc) · 15.7 KB
Raw

endpoint-test-results

Endpoint Test Results API

  • API version: 7.0.20

Retrieve results for scheduled and dynamic tests on endpoint agents.

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>endpoint-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:endpoint-test-results:<version>"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Getting Started

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

import com.thousandeyes.sdk.endpoint.tests.*;
import com.thousandeyes.sdk.endpoint.tests.client.*;
import com.thousandeyes.sdk.endpoint.tests.results.model.*;
import com.thousandeyes.sdk.endpoint.tests.results.HttpServerEndpointScheduledTestResultsApi;

public class HttpServerEndpointScheduledTestResultsApiExample {

    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();

        HttpServerEndpointScheduledTestResultsApi apiInstance = new HttpServerEndpointScheduledTestResultsApi(defaultClient);
        String testId = "202701"; // String | Test 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.
        String window = "12h"; // String | 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`.
        OffsetDateTime startDate = OffsetDateTime.parse("2022-07-17T22:00:54Z"); // OffsetDateTime | 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`.
        OffsetDateTime endDate = OffsetDateTime.parse("2022-07-18T22:00:54Z"); // OffsetDateTime | 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`.
        String cursor = "cursor_example"; // String | (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter.
        List<ExpandEndpointHttpServerOptions> expand = Arrays.asList(); // 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.
        try {
            HttpEndpointTestResults result = apiInstance.getHttpServerScheduledTestResults(testId, aid, window, startDate, endDate, cursor, expand);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HttpServerEndpointScheduledTestResultsApi#getHttpServerScheduledTestResults");
            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
HttpServerEndpointScheduledTestResultsApi getHttpServerScheduledTestResults GET /endpoint/test-results/scheduled-tests/{testId}/http-server Retrieve HTTP server scheduled test results
HttpServerEndpointScheduledTestResultsApi getHttpServerScheduledTestResultsWithHttpInfo GET /endpoint/test-results/scheduled-tests/{testId}/http-server Retrieve HTTP server scheduled test results
HttpServerEndpointScheduledTestResultsApi getMultiTestFilteredHttpServerScheduledTestResults POST /endpoint/test-results/scheduled-tests/http-server/filter Filter HTTP server scheduled test results
HttpServerEndpointScheduledTestResultsApi getMultiTestFilteredHttpServerScheduledTestResultsWithHttpInfo POST /endpoint/test-results/scheduled-tests/http-server/filter Filter HTTP server scheduled test results
LocalNetworkEndpointTestResultsApi filterLocalNetworksTestResultsTopologies POST /endpoint/test-results/local-networks/topologies/filter List endpoint network topologies probes
LocalNetworkEndpointTestResultsApi filterLocalNetworksTestResultsTopologiesWithHttpInfo POST /endpoint/test-results/local-networks/topologies/filter List endpoint network topologies probes
LocalNetworkEndpointTestResultsApi getLocalNetworksTestResults GET /endpoint/test-results/local-networks List local networks
LocalNetworkEndpointTestResultsApi getLocalNetworksTestResultsWithHttpInfo GET /endpoint/test-results/local-networks List local networks
LocalNetworkEndpointTestResultsApi getLocalNetworksTestResultsTopology GET /endpoint/test-results/local-networks/topologies/{networkTopologyId} Retrieve endpoint local network topology
LocalNetworkEndpointTestResultsApi getLocalNetworksTestResultsTopologyWithHttpInfo GET /endpoint/test-results/local-networks/topologies/{networkTopologyId} Retrieve endpoint local network topology
NetworkDynamicEndpointTestResultsApi filterDynamicTestNetworkResults POST /endpoint/test-results/dynamic-tests/{testId}/network/filter Retrieve network dynamic test results
NetworkDynamicEndpointTestResultsApi filterDynamicTestNetworkResultsWithHttpInfo POST /endpoint/test-results/dynamic-tests/{testId}/network/filter Retrieve network dynamic test results
NetworkDynamicEndpointTestResultsApi getDynamicTestPathVisAgentRoundResults GET /endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network dynamic test results details
NetworkDynamicEndpointTestResultsApi getDynamicTestPathVisAgentRoundResultsWithHttpInfo GET /endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network dynamic test results details
NetworkDynamicEndpointTestResultsApi getDynamicTestPathVisResults GET /endpoint/test-results/dynamic-tests/{testId}/path-vis Retrieve path visualization network dynamic test results
NetworkDynamicEndpointTestResultsApi getDynamicTestPathVisResultsWithHttpInfo GET /endpoint/test-results/dynamic-tests/{testId}/path-vis Retrieve path visualization network dynamic test results
NetworkEndpointScheduledTestResultsApi filterScheduledTestNetworkResults POST /endpoint/test-results/scheduled-tests/{testId}/network/filter Retrieve network scheduled test results
NetworkEndpointScheduledTestResultsApi filterScheduledTestNetworkResultsWithHttpInfo POST /endpoint/test-results/scheduled-tests/{testId}/network/filter Retrieve network scheduled test results
NetworkEndpointScheduledTestResultsApi filterScheduledTestsNetworkResults POST /endpoint/test-results/scheduled-tests/network/filter Retrieve network scheduled test results from multiple tests
NetworkEndpointScheduledTestResultsApi filterScheduledTestsNetworkResultsWithHttpInfo POST /endpoint/test-results/scheduled-tests/network/filter Retrieve network scheduled test results from multiple tests
NetworkEndpointScheduledTestResultsApi getScheduledTestPathVisAgentRoundResults GET /endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network scheduled test results details
NetworkEndpointScheduledTestResultsApi getScheduledTestPathVisAgentRoundResultsWithHttpInfo GET /endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId} Retrieve path visualization network scheduled test results details
NetworkEndpointScheduledTestResultsApi getScheduledTestPathVisResults GET /endpoint/test-results/scheduled-tests/{testId}/path-vis Retrieve path visualization network scheduled test results
NetworkEndpointScheduledTestResultsApi getScheduledTestPathVisResultsWithHttpInfo GET /endpoint/test-results/scheduled-tests/{testId}/path-vis Retrieve path visualization network scheduled test results
RealUserEndpointTestResultsApi filterRealUserTestsNetworkResults POST /endpoint/test-results/real-user-tests/networks/filter List endpoint real user tests
RealUserEndpointTestResultsApi filterRealUserTestsNetworkResultsWithHttpInfo POST /endpoint/test-results/real-user-tests/networks/filter List endpoint real user tests
RealUserEndpointTestResultsApi filterRealUserTestsResults POST /endpoint/test-results/real-user-tests/filter List endpoint real user tests
RealUserEndpointTestResultsApi filterRealUserTestsResultsWithHttpInfo POST /endpoint/test-results/real-user-tests/filter List endpoint real user tests
RealUserEndpointTestResultsApi filterRealUserTestsVisitedPagesResults POST /endpoint/test-results/real-user-tests/pages/filter List endpoint real user tests visited pages
RealUserEndpointTestResultsApi filterRealUserTestsVisitedPagesResultsWithHttpInfo POST /endpoint/test-results/real-user-tests/pages/filter List endpoint real user tests visited pages
RealUserEndpointTestResultsApi getRealUserTestPageResults GET /endpoint/test-results/real-user-tests/{id}/pages/{pageId} Retrieve endpoint real user test page
RealUserEndpointTestResultsApi getRealUserTestPageResultsWithHttpInfo GET /endpoint/test-results/real-user-tests/{id}/pages/{pageId} Retrieve endpoint real user test page
RealUserEndpointTestResultsApi getRealUserTestResults GET /endpoint/test-results/real-user-tests/{id} Retrieve endpoint real user test
RealUserEndpointTestResultsApi getRealUserTestResultsWithHttpInfo GET /endpoint/test-results/real-user-tests/{id} Retrieve endpoint real user test

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