ThousandEyes HTTP Server Endpoint Scheduled Test Results API is one of 98 APIs that ThousandEyes publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include HTTP Server Endpoint Scheduled Test Results. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
3 operations
across 3 paths,
and defines 101 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.
TestUseNtlm
boolean
Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set.
HttpErrorType
string
Type of error encountered; corresponds to phase of connection.
TestName
string
Name of the test.
TestIsSavedEvent
boolean
Indicates if the test is a saved event. Note: Saved Events are now called Private Snapshots in the user interface. This change does not affect API.
EndpointTestAgents
array
List of endpoint agent IDs (obtained from /endpoint/agents endpoint). Required when agentSelectorType is set to specific-agent.
TotalHits
integer
Total number of measurements that match the search criteria.
EndDate
string
(Optional) When passing window or endDate parameter, the client will also receive the endDate field indicating the UTC end date of the data's time range being…
TestCreatedDate
string
UTC created date (ISO date-time format).
HttpEndpointTestsDataRoundsSearch
object
3 properties
TestIsPrioritized
boolean
Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds the license limit.
EndpointHttpServerBaseTest
object
9 properties
HttpEndpointTestsDataThresholdFilters
object
All filters are applied based on the conditional operator (and/or).
2 properties
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.
EndpointScheduledTestType
string
Type of test being queried.
EndpointAgentId
string
Unique ID of endpoint agent, from /endpoint/agents endpoint.
EndpointTestPort
integer
Port number.
CellularProfile
object
Cellular network profile information for a mobile endpoint agent.
10 properties
EndpointAgentLabels
array
Deprecated. Use tagIds instead. List of endpoint agent label IDs (obtained from /endpoint/labels endpoint), required when agentSelectorType is set to agent-lab…
NetworkProxyProfile
object
2 properties
UserPrincipalName
string
User login name in Internet-style format, typically used in Active Directory environments.
TestInterval
integer
Interval between test runs in seconds.
TestLabel
object
3 properties
UserPrincipalNameFilter
array
Filters results based on an array of userPrincipalName values.
CpuUtilization
object
6 properties
TestFollowRedirects
boolean
To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to false.
NicDriverVersionFilter
array
Filters results to NIC driver versions that exactly match one of the provided values. Matching is case-sensitive.
HttpEndpointTestsDataThresholdFilter
object
The metric is filtered based on the threshold value and operator provided.
3 properties
NetworkWirelessProfile
object
10 properties
SystemMetrics
object
5 properties
HttpEndpointTestsDataSearchSortKey
string
EndpointSpecificAgentsSelectorType
string
EndpointTestAuthType
string
HTTP authentication type.
HttpMultiEndpointTestResults
object
5 properties
BatteryMetrics
object
Battery metrics for the endpoint agent.
3 properties
2 required
VpnType
string
Name of the VPN provider.
ExpandEndpointHttpServerOptions
string
TestIsEnabled
boolean
Indicates if test is enabled.
NetworkProxy
object
2 properties
HttpEndpointTestsDataSearchSort
object
2 properties
ApplicationScoreQuality
string
EndpointScoreNumeric
number
A fine-grained score between 0 and 100.
TestHasPathTraceInSession
boolean
Enables "in session" path trace. When enabled, this option initiates a TCP session with the target server and sends path trace packets within the established T…
UnauthorizedError
object
2 properties
BatteryLevel
string
Battery level indicator.
EndpointAllAgentsSelectorType
string
TestSslVersion
string
Reflects the verbose SSL protocol version used by a test.
TestNetworkMeasurements
boolean
Enable or disable network measurements. Set to true to enable or false to disable network measurements.
TestProbeModeResponse
string
Probe mode returned by network test APIs, only valid when the protocol is set to TCP. Configuration responses return user-selectable values, while result respo…
AccountGroupId
string
A unique identifier associated with your account group. You can retrieve your AccountGroupId from the /account-groups endpoint.
EndpointTestProtocol
string
Protocol requested for the test.
UserProfile
object
Details of the logged-in user, including username and user principal name.
2 properties
PaginationNextAndSelfLink
object
A links object containing a related link for forward pagination.
2 properties
EndpointAgentLabelsSelectorType
string
TargetProfile
object
3 properties
TestLabels
array
Labels to which the test is assigned. This field is not returned for Instant Tests.
Platform
string
OS platform types. Platform "linux" was recently renamed to "roomos".
NetworkInterface
object
8 properties
EndpointAgentTagsSelectorType
string
TagIds
array
List of tag IDs (obtained from /tags endpoint).
EndpointAgentSelectorConfig
object
Agents selection object based on agentSelectorType.
1 required
SortOrder
string
Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values.
Error
object
5 properties
HttpEndpointTestResultHeaders
object
Expandable object containing both request and response headers.
2 properties
EndpointHttpDataPointScore
object
2 properties
EndpointHttpServerType
string
Type of test being queried.
TestHttpVersion
integer
HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1.
HttpThresholdFilterName
string
Metric on which the threshold filter is applied.
EndpointAllAgentsSelectorConfig
object
Any agent selection object.
2 properties
1 required
InterfaceHardwareType
string
EndpointTestResultUrl
string
The test target URL.
ValidationErrorItem
object
3 properties
RoundId
integer
Epoch time (seconds) indicating the start time of the round.
PhysicalMemoryUsedBytes
object
6 properties
TestUsername
string
Username for Basic/NTLM authentication.
HttpEndpointTestsDataSearchFilter
object
5 properties
TestHttpTargetTime
integer
Target time for HTTP server completion, specified in milliseconds.
TestProtocol
string
Protocol used by dependent network tests (end-to-end, path trace, PMTUD).
ScheduledTestResults
array
Reference to the test results.
StartDate
string
(Optional) When passing window or startDate parameter, the client will also receive the startDate field indicating the UTC start date of the data's time range…
CellularNetworkGen
string
Cellular network generation.
TestId
string
Unique ID of endpoint test.
EndpointTestResult
object
13 properties
VpnProfile
object
4 properties
EndpointTest
object
20 properties
1 required
EndpointTestMaxMachines
integer
Maximum number of agents which can execute the test.
Link
object
A hyperlink from the containing resource to a URI.
8 properties
1 required
ThresholdFilterOperator
string
EndpointAgentLabelsSelectorConfig
object
Agent labels selection object.
4 properties
1 required
EndpointIpVersionOut
string
For reading current network test configurations, the IP version of the test. Values include V4ONLY, V6ONLY, V6PREFER, and OSDEFAULT.
HttpEndpointTestResults
object
6 properties
EndpointSpecificAgentsSelectorConfig
object
Specific agents selection object.
3 properties
1 required
EndpointTestEthernetProfile
object
1 property
ConditionalOperator
string
NicModelFilter
array
Filters results to NIC models that exactly match one of the provided values. Matching is case-sensitive.
EndpointAgentTagsSelectorConfig
object
Agent tags selection object.
4 properties
1 required
EndpointTestLinks
object
A list of links that can be accessed to get more information.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs ThousandEyes publishes across the network.
