ThousandEyes Web Transaction Tests API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Web Transaction Tests. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
5 operations
across 2 paths,
and defines 110 schemas.
It is described by OpenAPI 3.2.0, at version 7.0.100.
Requests are made against a single base URL, https://api.thousandeyes.com/v7.
The identity and technical contract details declared by the specification.
TestMtuMeasurements
boolean
Set true to measure MTU sizes on network from agents to the target.
TestUseNtlm
boolean
Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.
TestUserAgent
string
User-agent string to be provided during the test.
TestUrl
string
Target for the test.
TestChromePolicies
string
JSON string of Chrome policy settings to apply.
TestCreatedDate
string
UTC created date (ISO date-time format).
MonitorType
string
Type of monitor
TestCreatedBy
string
User that created the test.
RequestMethod
string
HTTP request method.
TestBrowserLanguage
string
Set one of the available browser language that you want to use to configure the browser.
TestDisableScreenshot
boolean
Enables or disables screenshots on error. Set true to not capture
TestLinks
object
A list of links that can be accessed to get more information
2 properties
TestPageLoadingStrategy
string
normal: The test waits until the entire page is fully loaded, including the downloading and parsing of HTML content as well as all associated resources, before…
AlertType
string
Type of alert being triggered. In multi-layered tests, this value represents the layer the alert relates to. See [Alert Details](https://developer.cisco.com/do…
TestSslVersionId
string
SSL version options: Use '0' for automatic selection. Use '3' for SSLv3. Use '4' for TLS v1.0. Use '5' for TLS v1.1. Use '6' for TLS v1.2. Use '7' for TLS v1.3.
TestAgentRequest
object
2 properties
1 required
TestOverrideProxyId
string
ID of the proxy to be used if the default proxy is overridden.
TestPathTraceMode
string
Select inSession to perform the path trace within a TCP session.
TestAuthType
string
HTTP authentication type.
TestInterval
integer
Interval between test runs in seconds.
TestLabel
object
3 properties
HttpServerBaseProperties
object
36 properties
TestFollowRedirects
boolean
To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to false.
TestSubInterval
integer
Subinterval for round-robin testing (in seconds). Must be less than or equal to interval and must evenly divide interval.
TestCredentials
array
Contains a list of credential IDs (get credentialId from /credentials endpoint).
OAuthAuthType
string
HTTP authentication type used for the OAuth request.
WebTransactionInstantTest
SelfLinks
object
A links object containing the self link.
1 property
TestBgpMonitors
array
Contains list of enabled BGP monitors.
SharedWithAccount
object
2 properties
TestWebTransactionType
string
WebTransactionTestResponse
Coordinates
object
Geographic coordinates for agent location.
2 properties
AlertRule
object
13 properties
TestTag
object
3 properties
TestOverrideAgentProxy
boolean
Flag indicating if a proxy other than the default should be used. To override the default proxy for agents, set to true and specify a value for overrideProxyId.
BaseRequest
object
4 properties
TestCollectProxyNetworkData
boolean
Indicates whether network data to the proxy should be collected.
AgentInterfaces
object
2 properties
OAuth
object
Use this only if you want to use OAuth as the authentication mechanism.
7 properties
AlertRoundsViolationMode
string
exact requires the same agents to meet the threshold in consecutive rounds. auto is only enabled for CEA and Endpoint Scheduled test rules. The default is any.
UnexpandedInstantTest
object
11 properties
TestType
string
This is a read only value, as test type is implicit in the test creation url.
TestCustomHeaders
object
3 properties
UnauthorizedError
object
2 properties
TestResults
array
Reference to the test results.
TestAgentsResponse
array
Contains list of agents.
UnexpandedWebTransactionTest
TestRandomizedStartTime
boolean
Indicates whether agents should randomize the start time in each test round.
TestBgpMeasurements
boolean
Set to true to enable bgp measurements.
TestSslVersion
string
Reflects the verbose SSL protocol version used by a test.
TestIncludeHeaders
boolean
Set to true to capture response headers for objects loaded by the test.
TestNetworkMeasurements
boolean
Enable or disable network measurements. Set to true to enable or false to disable network measurements.
AlertDirection
string
Direction for applicable alert types (eg. path trace, End-to-End (Agent) etc.)
TestIdentifyAgentTrafficWithUserAgent
boolean
Determines how agent traffic is identified: false: Adds the x-thousandeyes-agent: yes header. true: Appends (ThousandEyes Agent) to the user-agent header. For…
UnexpandedTest
object
3 properties
TestChromiumTrack
string
stable: Uses the default Chromium version. latest: Uses the newest Chromium version available from ThousandEyes as soon as it is available. Performance may dif…
Monitor
object
6 properties
TestAllowMicAndCamera
boolean
Set true allow the use of a fake mic and camera in the browser.
TestAgentsRequest
array
Contains list of Agent IDs (get agentId from /agents endpoint).
TestChromeOptions
string
Command-line options passed to Chrome when running the test.
TestLabels
array
Labels to which the test is assigned. This field is not returned for Instant Tests.
RuleId
string
Unique ID of the rule.
TestFixedPacketRate
integer
Sets packets rate sent to measure the network in packets per second.
TestAllowUnsafeLegacyRenegotiation
boolean
Allows TLS renegotiation with servers not supporting RFC 5746. Default Set to true to allow unsafe legacy renegotiation.
TestPassword
string
Password for Basic/NTLM authentication.
Enabled
boolean
Test is enabled.
TestBandwidthMeasurements
boolean
Set to true to enable bandwidth measurements, only applies to Enterprise agents assigned to the test.
TestMonitorsProperties
object
3 properties
Error
object
5 properties
TestProbeMode
string
Probe mode used by network test, only valid when the protocol is set to TCP.
AgentBase
object
3 properties
TestTags
array
Tags assigned to the test. Returned only when expand=tag is specified. This field is not returned for Instant Tests. For more information, see /tags.
TestVaultCredentialTarget
string
The target setting that the credential should be used for.
CloudEnterpriseAgentType
string
Type of the agent.
TestHttpVersion
integer
HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.
TestDistributedTracing
boolean
Adds distributed tracing headers to API requests using B3 and W3C standards.
TestBlockDomains
string
Domains or full object URLs to be excluded from metrics and waterfall data for transaction tests.
Severity
string
The severity of the alert.
TestNumPathTraces
integer
Number of path traces executed by the agent.
TestDesiredStatusCode
string
Specify the HTTP status code value that indicates a successful response. The default value accepts any 2xx or 3xx status code.
MonitorsRequest
object
1 property
TestWebTransactionTimeLimit
integer
Time limit for transaction in seconds.
TestUsePublicBgp
boolean
Indicate if all available public BGP monitors should be used, when ommited defaults to bgpMeasurements value.
TestClientCertificate
string
String representation (containing newline characters) of client certificate, the private key must be placed first, then the certificate.
TestVerifyCertificate
boolean
Ignore or acknowledge certificate errors. Set to false to ignore certificate errors.
ValidationErrorItem
object
3 properties
TestAllowGeolocation
boolean
Set true to use the agent’s geolocation by the web page.
TestHttpTimeLimit
integer
HTTP time limit in seconds.
TestUsername
string
Username for Basic/NTLM authentication.
TestHttpTargetTime
integer
Target time for HTTP server completion, specified in milliseconds.
SensitivityLevel
string
Used when roundsViolatingMode is set to auto. The default is medium. Higher sensitivity increases the likelihood of triggering alerts.
TestProtocol
string
Protocol used by dependent network tests (end-to-end, path trace, PMTUD).
Link
object
A hyperlink from the containing resource to a URI.
8 properties
1 required
WebTransactionTestRequest
WebTransactionTests
object
2 properties
NetworkProviderInfo
object
Information about the network provider that owns the agent's public IP prefix.
3 properties
TestVaultCredential
object
2 properties
NetworkProviderType
string
Classification of the agent's network provider.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ThousandEyes publishes across the network.
