thousandeyes-sdk-python/test_results_api/docs/WebHTTPServerTestMetricsApi.md

test_results_api.WebHTTPServerTestMetricsApi

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

Method	HTTP request	Description
get_test_result_http_server	GET /v7/test-results/{testId}/http-server	Get HTTP server test results

get_test_result_http_server

GetTestResultHttpServer200Response get_test_result_http_server(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, expand=expand)

Get HTTP server test results

Returns results for requests made over HTTP. Components include DNS, Connect, Wait, Receive, and Fetch.

Example

• Bearer Authentication (BearerAuth):

import time
import os
import test_results_api
from test_results_api.models.expand import Expand
from test_results_api.models.get_test_result_http_server200_response import GetTestResultHttpServer200Response
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.WebHTTPServerTestMetricsApi(api_client)
    test_id = '202701' # str | Test 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)
    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 `_links` instead of this parameter. (optional)
    expand = [test_results_api.Expand()] # List[Expand] | This parameter lets you decide if you want to see more details about test results. By default, no extra information is shown unless you use the query parameter. For instance, if you want more info about the \"header,\" add ?expand=header to the query. (optional)

    try:
        # Get HTTP server test results
        api_response = api_instance.get_test_result_http_server(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor, expand=expand)
        print("The response of WebHTTPServerTestMetricsApi->get_test_result_http_server:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebHTTPServerTestMetricsApi->get_test_result_http_server: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
aid	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	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	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	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	str	(Optional) Opaque cursor used for pagination. Clients should use `_links` instead of this parameter.	[optional]
expand	**List[Expand]**	This parameter lets you decide if you want to see more details about test results. By default, no extra information is shown unless you use the query parameter. For instance, if you want more info about the "header," add ?expand=header to the query.	[optional]

Return type

GetTestResultHttpServer200Response

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json, application/problem+json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	Insufficient permissions to query endpoint	-
404	Not found	-
429	Exhausted rate limit for the organization	-
500	Internal server error	-
502	Bad Gateway	-
0	An error occurred	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]