thousandeyes-sdk-python/thousandeyes-sdk-test-results/docs/WebTransactionsTestMetricsApi.md

thousandeyes_sdk.test_results.WebTransactionsTestMetricsApi

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

Method	HTTP request	Description
get_test_web_transaction_agent_round_page_results	GET /v7/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId}	Get detailed web transactions test result by agent, round, and page
get_test_web_transaction_agent_round_results	GET /v7/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}	Get web transactions test results by agent and round
get_test_web_transaction_results	GET /v7/test-results/{testId}/web-transactions	Get web transactions test results

get_test_web_transaction_agent_round_page_results

WebTransactionPageDetailTestResults get_test_web_transaction_agent_round_page_results(test_id, agent_id, round_id, page_id, aid=aid)

Get detailed web transactions test result by agent, round, and page

Returns a page of web transaction test results for an agent and round.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.test_results
from thousandeyes_sdk.test_results.models.web_transaction_page_detail_test_results import WebTransactionPageDetailTestResults
from thousandeyes_sdk.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 = 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.test_results.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.test_results.WebTransactionsTestMetricsApi(api_client)
    test_id = '202701' # str | Test ID
    agent_id = '11' # str | Agent ID
    round_id = '1384309800' # str | Round ID
    page_id = '281474976710706' # str | Web page 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)

    try:
        # Get detailed web transactions test result by agent, round, and page
        api_response = api_instance.get_test_web_transaction_agent_round_page_results(test_id, agent_id, round_id, page_id, aid=aid)
        print("The response of WebTransactionsTestMetricsApi->get_test_web_transaction_agent_round_page_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebTransactionsTestMetricsApi->get_test_web_transaction_agent_round_page_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
agent_id	str	Agent ID
round_id	str	Round ID
page_id	str	Web page 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]

Return type

WebTransactionPageDetailTestResults

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json, application/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]

get_test_web_transaction_agent_round_results

WebTransactionDetailTestResults get_test_web_transaction_agent_round_results(test_id, agent_id, round_id, aid=aid)

Get web transactions test results by agent and round

Returns test results for web transactions for a given agent and round.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.test_results
from thousandeyes_sdk.test_results.models.web_transaction_detail_test_results import WebTransactionDetailTestResults
from thousandeyes_sdk.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 = 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.test_results.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.test_results.WebTransactionsTestMetricsApi(api_client)
    test_id = '202701' # str | Test ID
    agent_id = '11' # str | Agent ID
    round_id = '1384309800' # str | Round 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)

    try:
        # Get web transactions test results by agent and round
        api_response = api_instance.get_test_web_transaction_agent_round_results(test_id, agent_id, round_id, aid=aid)
        print("The response of WebTransactionsTestMetricsApi->get_test_web_transaction_agent_round_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebTransactionsTestMetricsApi->get_test_web_transaction_agent_round_results: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_id	str	Test ID
agent_id	str	Agent ID
round_id	str	Round 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]

Return type

WebTransactionDetailTestResults

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json, application/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]

get_test_web_transaction_results

WebTransactionTestResults get_test_web_transaction_results(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor)

Get web transactions test results

Returns test results for web transactions. If you do not specify a window or a start and end date, data is displayed for the most recent testing round.

Example

• Bearer Authentication (BearerAuth):

import thousandeyes_sdk.test_results
from thousandeyes_sdk.test_results.models.web_transaction_test_results import WebTransactionTestResults
from thousandeyes_sdk.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 = 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.test_results.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = thousandeyes_sdk.test_results.WebTransactionsTestMetricsApi(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 web transactions test results
        api_response = api_instance.get_test_web_transaction_results(test_id, aid=aid, window=window, start_date=start_date, end_date=end_date, cursor=cursor)
        print("The response of WebTransactionsTestMetricsApi->get_test_web_transaction_results:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling WebTransactionsTestMetricsApi->get_test_web_transaction_results: %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 `next` value from `_links` instead of this parameter.	[optional]

Return type

WebTransactionTestResults

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/hal+json, application/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]