openapi: 3.0.1 security: - BearerAuth: [] servers: - description: ThousandEyes API production URL url: https://api.thousandeyes.com/v7 info: title: Endpoint Test Results API version: 7.0.100 description: Retrieve results for scheduled and dynamic tests on endpoint agents. x-provenance: method: harvested authored_by: Cisco ThousandEyes harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: pubhub.devnetcloud.com note: 27 OpenAPI 3.0 documents (26 per-area plus a unified 326-operation document) served anonymously from Cisco's DevNet CDN. api.thousandeyes.com itself 401s every path, so the contract is public while the API host is gated. x-evidence: - type: source url: https://pubhub.devnetcloud.com/media/000-v7-apis/docs/reference/ - type: source url: https://developer.cisco.com/docs/thousandeyes/ tags: - name: Network Endpoint Scheduled Test Results - name: HTTP Server Endpoint Scheduled Test Results - name: Network Dynamic Endpoint Test Results - name: Real User Endpoint Test Results - name: Local Network Endpoint Test Results paths: /endpoint/test-results/scheduled-tests/{testId}/network/filter: post: tags: - Network Endpoint Scheduled Test Results summary: Retrieve network scheduled test results description: 'Returns network metrics (loss, latency, and jitter) from each endpoint agent, for each roundId within the specified time window, as determined by search filters. If a time frame is provided, the rounds relevant to that time frame are returned, and the order is not predefined unless the user specifies a sort order in the filter. When no time frame is provided, the latest rounds are returned. ' operationId: filterScheduledTestNetworkResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/ExpandEndpointNetwork' requestBody: description: Tests data search filters. content: application/json: schema: $ref: '#/components/schemas/EndpointTestsDataRoundsSearch' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/NetworkEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/network/filter: post: tags: - Network Endpoint Scheduled Test Results summary: Retrieve network scheduled test results from multiple tests description: 'Returns network metrics, including loss, latency, and jitter, for multiple test IDs obtained from each endpoint agent. It allows you to specify a time window using search filters to retrieve metrics for specific round IDs within that time frame. The default order of results is unspecified unless you include a sorting preference in the filter. When no time frame is provided, the API returns metrics for the most recent rounds. Access to all accounts associated with the specified test IDs is required to use this endpoint. ' operationId: filterScheduledTestsNetworkResults parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationMax' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/UseAllPermittedAids' - $ref: '#/components/parameters/ExpandEndpointNetwork' requestBody: description: Test data search filters. content: application/json: schema: $ref: '#/components/schemas/MultiTestIdEndpointTestsDataRoundsSearch' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/MultiTestIdNetworkEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/{testId}/path-vis: get: tags: - Network Endpoint Scheduled Test Results summary: Retrieve path visualization network scheduled test results description: 'Returns a summary of the path visualization data collected from each endpoint agent to the destination. In each path visualization attempt, one attempt is made to reach the destination. Each set of data is summarized, based on response time, number of hops, and response time to the target. A time frame must be specified, or the most recent round within last 2 hours is returned. ' operationId: getScheduledTestPathVisResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/PathVisEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId}: get: tags: - Network Endpoint Scheduled Test Results summary: Retrieve path visualization network scheduled test results details description: 'Returns a hop-by-hop summary of the path trace data collected during path visualization. In each round, one path discovery attempt is made to reach the destination. The entire path is returned. A `roundId` must be specified. ' operationId: getScheduledTestPathVisAgentRoundResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AgentIdPath' - $ref: '#/components/parameters/RoundIdPath' - $ref: '#/components/parameters/AccountGroupId' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/PathVisDetailEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/{testId}/http-server: get: tags: - HTTP Server Endpoint Scheduled Test Results summary: Retrieve HTTP server scheduled test results description: 'Returns component-level (DNS, Connect, Wait and Receive) timing for the load of an object over HTTP. ' operationId: getHttpServerScheduledTestResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/ExpandEndpointHttpServer' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/HttpEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/dynamic-tests/{testId}/network/filter: post: tags: - Network Dynamic Endpoint Test Results summary: Retrieve network dynamic test results description: 'Returns network metrics (`loss`, `latency`, `jitter` and `bandwidth`) from each endpoint agent, for each `roundId` in the requested window. When Time Frame is provided the rounds specific to the time frame is returned and the order is not pre-defined unless a user specifies the sort order in filter. When no time frame is provided the latest rounds are returned. ' operationId: filterDynamicTestNetworkResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/ExpandEndpointDynamicNetwork' requestBody: description: Tests data search filters. content: application/json: schema: $ref: '#/components/schemas/DynamicEndpointTestsDataRoundSearch' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/NetworkDynamicEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/{testId}/http-server/filter: post: tags: - HTTP Server Endpoint Scheduled Test Results summary: Filter HTTP server result for a scheduled test description: 'Returns component-level timings for an object load over HTTP. These include DNS, connect, wait, and receive times for a single scheduled test. ' operationId: getSingleTestFilteredHttpServerScheduledTestResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/ExpandEndpointHttpServer' requestBody: description: Test result search filters. content: application/json: schema: $ref: '#/components/schemas/HttpEndpointTestsDataRoundsSearch' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/HttpMultiEndpointTestResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/scheduled-tests/http-server/filter: post: tags: - HTTP Server Endpoint Scheduled Test Results summary: Filter HTTP server scheduled test results description: 'Returns component-level (DNS, Connect, Wait and Receive) timing for the load of an object over HTTP. ' operationId: getMultiTestFilteredHttpServerScheduledTestResults parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/UseAllPermittedAids' - $ref: '#/components/parameters/ExpandEndpointHttpServer' requestBody: description: Test data search filters. content: application/json: schema: $ref: '#/components/schemas/HttpEndpointTestsDataRoundsSearch' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/HttpMultiEndpointTestResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/dynamic-tests/{testId}/path-vis: get: tags: - Network Dynamic Endpoint Test Results summary: Retrieve path visualization network dynamic test results description: 'Returns a summary of the path visualization data collected from each endpoint agent to the destination. In each path visualization attempt, one attempt is made to reach the destination. Each set of data is summarized, based on response time, number of hops, and response time to the target. A time frame must be specified, or the most recent round within last 2 hours will be returned. ' operationId: getDynamicTestPathVisResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/PathVisDynamicEndpointTestResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId}: get: tags: - Network Dynamic Endpoint Test Results summary: Retrieve path visualization network dynamic test results details description: 'Returns a hop-by-hop summary of the path trace data collected during path visualization. In each round, one path discovery attempt is made to reach the destination. The entire path is returned. A `roundId` must be specified. ' operationId: getDynamicTestPathVisAgentRoundResults parameters: - $ref: '#/components/parameters/TestIdPath' - $ref: '#/components/parameters/AgentIdPath' - $ref: '#/components/parameters/RoundIdPath' - $ref: '#/components/parameters/AccountGroupId' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/PathVisDetailDynamicEndpointTestResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/real-user-tests/filter: post: tags: - Real User Endpoint Test Results summary: List endpoint real user tests description: "Returns a list of all endpoint real user tests.\nAll results are provided, oldest to newest (according\ \ to a specified page index and size) unless an explicit start and end is provided with `startDate`, `endDate` or\ \ `window` optional parameters.\n\n## Request body filters\nThis endpoint supports complex filtering using the request\ \ body.\nIt is important these filters remain unaltered when making use of pagination, otherwise the results will\ \ not be coherent with the original request.\n\n### Multiple filter fields\nWhen multiple filter fields are provided,\ \ a logical `AND` is applied between the filters.\n ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ]\n }}'\n```\n\n### Filter field with\ \ multiple values\nWhen a filter field contains multiple values, a logical `OR` is applied between the filter values.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ]\n }\n }'\n```\n\n### Combination of request parameters\ \ and body filters\n```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/filter?window=1w'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ],\n \"networkId\": [ \"660b34109d12\"\ , \"660b34109d15\" ]\n }\n }'\n```\n\nReturns a `results` array of endpoint real user tests.\nEither the latest\ \ results, or based on the time range and body filters specified.\n" operationId: filterRealUserTestsResults parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealUserEndpointTestResultsRequest' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/RealUserEndpointTestResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/real-user-tests/{id}: get: tags: - Real User Endpoint Test Results summary: Retrieve endpoint real user test description: 'Provides details for an endpoint real user test. Returns a results array containing detailed information about endpoint real user tests." ' operationId: getRealUserTestResults parameters: - $ref: '#/components/parameters/IdPath' - $ref: '#/components/parameters/AccountGroupId' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/RealUserEndpointTestDetailResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/real-user-tests/pages/filter: post: tags: - Real User Endpoint Test Results summary: List endpoint real user tests visited pages description: "Returns a list of all endpoint real user tests visited pages. \nSessions from the last round are provided\ \ unless an explicit start and end is provided with `startDate`, `endDate` or `window` optional parameters.\n\n##\ \ Request body filters\nThis endpoint supports complex filtering using the request body.\nIt is important these filters\ \ remain unaltered when making use of pagination, otherwise the results will not be coherent with the original request.\n\ \n### Multiple filter fields\nWhen multiple filter fields are provided, a logical `AND` is applied between the filters.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/pages/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ]\n }}'\n```\n\n### Filter field with\ \ multiple values\nWhen a filter field contains multiple values, a logical `OR` is applied between the filter values.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/pages/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ]\n }}'\n```\n\n### Combination of request parameters\ \ and body filters\n```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/pages/filter?window=1w'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ],\n \"networkId\": [ \"660b34109d12\"\ , \"660b34109d15\" ]\n }}'\n```\n\nReturns a `results` array of user loaded pages in an endpoint real user test.\ \ \nPages shown are from the latest round, or based on the time range specified.\n" operationId: filterRealUserTestsVisitedPagesResults parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealUserEndpointTestResultRequestFilter' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/RealUserEndpointTestPageResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/real-user-tests/{id}/pages/{pageId}: get: tags: - Real User Endpoint Test Results summary: Retrieve endpoint real user test page description: "Returns details for endpoint real user test web page request. \nProvides complete waterfall information\ \ with all object requests.\n\nSends back detailed endpoint real user test web page request.\n\nReturned object has\ \ a single field: `har` which is an HAR object according to the HTTP Archive 1.2 specifications. \n[You can read more\ \ about the specification](http://www.softwareishard.com/blog/har-12-spec/).\n\nIn addition to standard fields, the\ \ object har includes a custom property `systemMetrics` which contain metrics about CPU and physical memory usage.\ \ \nCheck `SystemMetrics` on schemas tab for more information.\n" operationId: getRealUserTestPageResults parameters: - $ref: '#/components/parameters/IdPath' - $ref: '#/components/parameters/PageIdPath' - $ref: '#/components/parameters/AccountGroupId' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/RealUserEndpointTestPageDetailResult' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/real-user-tests/networks/filter: post: tags: - Real User Endpoint Test Results summary: List endpoint real user tests networks description: "Returns a list of all endpoint real user tests. \nSessions from the last round are provided unless an\ \ explicit start and end is provided with `startDate`, `endDate` or `window` optional parameters.\n\n## Request body\ \ filters\nThis endpoint supports complex filtering using the request body.\nIt is important these filters remain\ \ unaltered when making use of pagination, otherwise the results will not be coherent with the original request.\n\ \n### Multiple filter fields\nWhen multiple filter fields are provided, a logical `AND` is applied between the filters.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ]\n }}'\n```\n\n### Filter field with\ \ multiple values\nWhen a filter field contains multiple values, a logical `OR` is applied between the filter values.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ]\n }}'\n```\n\n### Combination of request parameters\ \ and body filters\n```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/real-user-tests/networks/filter?window=1w'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ],\n \"networkId\": [ \"660b34109d12\"\ , \"660b34109d15\" ]\n }}'\n```\n\nReturns a `results` array of endpoint real user tests. \nNetwork sessions shown\ \ are from the latest round, or based on the time range specified.\n" operationId: filterRealUserTestsNetworkResults parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' requestBody: content: application/json: schema: $ref: '#/components/schemas/RealUserEndpointTestResultsRequest' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/RealUserEndpointTestNetworkResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/local-networks: get: tags: - Local Network Endpoint Test Results summary: List local networks description: 'Returns a list of all the networks used by endpoint agents. Sends back a `localNetworks` array. ' operationId: getLocalNetworksTestResults parameters: - $ref: '#/components/parameters/AccountGroupId' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/LocalNetworkResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/local-networks/topologies/filter: post: tags: - Local Network Endpoint Test Results summary: List endpoint network topologies probes description: "Returns a list of all endpoint local network topologies probes. \nAll results are provided, oldest to\ \ newest (according to a specified page index and size) unless an explicit start and end is provided with `startDate`,\ \ `endDate` or `window` optional parameters.\n\n## Request body filters\nThis endpoint supports complex filtering\ \ using the request body.\nIt is important these filters remain unaltered when making use of pagination, otherwise\ \ the results will not be coherent with the original request.\n\n### Multiple filter fields\nWhen multiple filter\ \ fields are provided, a logical `AND` is applied between the filters.\n ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ]\n }}'\n```\n\n### Filter field with\ \ multiple values\nWhen a filter field contains multiple values, a logical `OR` is applied between the filter values.\n\ \ ```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"networkId\": [ \"660b34109d12\", \"660b34109d15\" ]\n }}'\n```\n\n### Combination of request parameters\ \ and body filters\n```\ncurl --location --request POST 'https://api.thousandeyes.com/v7/endpoint/test-results/local-networks/topologies/filter?window=12h'\n\ --header 'Authorization: Bearer $token'\n--header 'Content-Type: application/json'\n--data-raw '{\n \"searchFilters\"\ : {\n \"platform\": [ \"mac\" ],\n \"domain\": [ \"thousandeyes.com\" ],\n \"networkId\": [ \"660b34109d12\"\ , \"660b34109d15\" ]\n }}'\n```\n\n### Warning\nNote that a maximum of 12h worth of data can be retrieved at once.\ \ \nIf you need more, you need to make multiple requests.\n\nReturns a `results` array of network topology probes.\ \ \nNetwork topology probes shown are from the latest round, or based on the time range specified.\n" operationId: filterLocalNetworksTestResultsTopologies parameters: - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/Window' - $ref: '#/components/parameters/StartDateParameter' - $ref: '#/components/parameters/EndDateParameter' - $ref: '#/components/parameters/PaginationCursor' - $ref: '#/components/parameters/ExpandLocalNetworkTopology' requestBody: content: application/json: schema: $ref: '#/components/schemas/EndpointNetworkTopologyResultRequest' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/LocalNetworkTopologyResults' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' /endpoint/test-results/local-networks/topologies/{networkTopologyId}: get: tags: - Local Network Endpoint Test Results summary: Retrieve endpoint local network topology description: 'Returns detailed data of a local network topology. ' operationId: getLocalNetworksTestResultsTopology parameters: - $ref: '#/components/parameters/NetworkTopologyIdPath' - $ref: '#/components/parameters/AccountGroupId' - $ref: '#/components/parameters/ExpandLocalNetworkTopology' responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/LocalNetworkTopologyDetailResults' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' components: securitySchemes: BearerAuth: type: http scheme: bearer description: Bearer authentication token schemas: TestId: type: string description: Unique ID of endpoint test. example: '584739201' readOnly: true RoundId: type: integer description: Epoch time (seconds) indicating the start time of the round. example: 1384309800 readOnly: true EndpointTestsDataRoundsSearch: type: object properties: searchSort: type: array items: $ref: '#/components/schemas/EndpointTestsDataSearchSort' thresholdFilter: $ref: '#/components/schemas/EndpointTestsDataThresholdFilters' searchFilters: $ref: '#/components/schemas/EndpointTestsDataSearchFilter' MultiTestIdEndpointTestsDataRoundsSearch: type: object properties: searchSort: type: array items: $ref: '#/components/schemas/EndpointTestsDataSearchSort' thresholdFilter: $ref: '#/components/schemas/EndpointTestsDataThresholdFilters' searchFilters: $ref: '#/components/schemas/MultiTestIdEndpointTestsDataSearchFilter' DynamicEndpointTestsDataRoundSearch: type: object properties: searchSort: type: array items: $ref: '#/components/schemas/EndpointTestsDataSearchSort' thresholdFilter: $ref: '#/components/schemas/EndpointTestsDataThresholdFilters' searchFilters: $ref: '#/components/schemas/DynamicEndpointTestsDataSearchFilter' HttpEndpointTestsDataRoundsSearch: type: object properties: searchSort: type: array items: $ref: '#/components/schemas/HttpEndpointTestsDataSearchSort' thresholdFilter: $ref: '#/components/schemas/HttpEndpointTestsDataThresholdFilters' searchFilters: $ref: '#/components/schemas/HttpEndpointTestsDataSearchFilter' HttpEndpointTestsDataSearchSort: type: object properties: sort: $ref: '#/components/schemas/HttpEndpointTestsDataSearchSortKey' order: $ref: '#/components/schemas/SortOrder' HttpEndpointTestsDataSearchSortKey: type: string enum: - round-id - response-time - dns-time - connect-time - ssl-time - wait-time - response-code - wire-size example: round-id HttpEndpointTestsDataThresholdFilters: type: object description: All filters are applied based on the conditional operator (and/or). properties: filters: type: array items: $ref: '#/components/schemas/HttpEndpointTestsDataThresholdFilter' conditionalOperator: $ref: '#/components/schemas/ConditionalOperator' HttpEndpointTestsDataThresholdFilter: type: object description: The metric is filtered based on the threshold value and operator provided. properties: name: $ref: '#/components/schemas/HttpThresholdFilterName' value: type: number description: The threshold value. format: double example: 10 operator: $ref: '#/components/schemas/ThresholdFilterOperator' HttpThresholdFilterName: type: string description: Metric on which the threshold filter is applied. enum: - response-time - dns-time - connect-time - throughput - ssl-time - wait-time - application-score example: response-time HttpEndpointTestsDataSearchFilter: type: object properties: testId: description: Filter by test type: array items: type: string example: '5' agentId: description: Filter using the `agent-id`. type: array items: type: string format: uuid example: 52455b09-ff1b-4849-8194-99026cc890e0 userPrincipalName: $ref: '#/components/schemas/UserPrincipalNameFilter' nicModel: $ref: '#/components/schemas/NicModelFilter' nicDriverVersion: $ref: '#/components/schemas/NicDriverVersionFilter' EndpointTestsDataSearchSort: type: object properties: sort: $ref: '#/components/schemas/EndpointTestsDataSearchSortKey' order: $ref: '#/components/schemas/SortOrder' EndpointTestsDataSearchSortKey: type: string enum: - round-id - loss - latency - jitter - cpu - memory - signal-quality example: round-id EndpointTestsDataThresholdFilters: type: object description: All filters are applied based on the conditional operator (and/or). properties: filters: type: array items: $ref: '#/components/schemas/EndpointTestsDataThresholdFilter' conditionalOperator: $ref: '#/components/schemas/ConditionalOperator' EndpointTestsDataThresholdFilter: type: object description: The metric is filtered based on the threshold value and operator provided. properties: name: $ref: '#/components/schemas/ThresholdFilterName' value: type: number description: The threshold value. format: double example: 10 operator: $ref: '#/components/schemas/ThresholdFilterOperator' ThresholdFilterName: type: string description: Metric on which the threshold filter is applied. enum: - loss - latency - jitter - cpu - memory - signal-quality - application-score - zta-ingress-loss - zta-service-loss - zta-ingress-avg-latency - zta-service-avg-latency - zta-ingress-jitter - zta-service-jitter example: loss EndpointTestsDataSearchFilter: type: object properties: agentId: description: Filter using the `agent-id`. type: array items: type: string format: uuid example: 52455b09-ff1b-4849-8194-99026cc890e0 userPrincipalName: $ref: '#/components/schemas/UserPrincipalNameFilter' nicModel: $ref: '#/components/schemas/NicModelFilter' nicDriverVersion: $ref: '#/components/schemas/NicDriverVersionFilter' MultiTestIdEndpointTestsDataSearchFilter: type: object properties: agentId: description: Filter using the `agent-id`. type: array items: type: string format: uuid example: 52455b09-ff1b-4849-8194-99026cc890e0 testId: type: array items: type: string example: '5' nicModel: $ref: '#/components/schemas/NicModelFilter' nicDriverVersion: $ref: '#/components/schemas/NicDriverVersionFilter' DynamicEndpointTestsDataSearchFilter: type: object properties: agentId: description: Filter using the `agent-id`. type: array items: type: string format: uuid example: 52455b09-ff1b-4849-8194-99026cc890e0 userPrincipalName: $ref: '#/components/schemas/UserPrincipalNameFilter' nicModel: $ref: '#/components/schemas/NicModelFilter' nicDriverVersion: $ref: '#/components/schemas/NicDriverVersionFilter' webexConferenceId: description: Filter using the `conference-id` of the Webex call. type: array items: type: string example: '719057112996612360' webexCorrelationId: description: Filter using the `correlation-id` of the Webex call. type: array items: type: string format: uuid example: f7d73641-8673-4547-be62-9521f78d9888 webexLocalSipSessionId: description: Filter using the `local-sip-session-id` of the Webex call. type: array items: type: string example: c124ba2b012050008000aa0c26c4bf0f EndpointTestResult: type: object properties: aid: $ref: '#/components/schemas/AccountGroupId' testId: $ref: '#/components/schemas/TestId' agentId: $ref: '#/components/schemas/EndpointAgentId' roundId: $ref: '#/components/schemas/RoundId' serverIp: type: string description: IP address of target server. example: 185.199.108.153 readOnly: true networkProfile: $ref: '#/components/schemas/NetworkProfile' systemMetrics: $ref: '#/components/schemas/SystemMetrics' originalTargetProfile: $ref: '#/components/schemas/TargetProfile' userProfile: $ref: '#/components/schemas/UserProfile' vpnProfile: $ref: '#/components/schemas/VpnProfile' batteryMetrics: $ref: '#/components/schemas/BatteryMetrics' cellularProfile: $ref: '#/components/schemas/CellularProfile' platform: $ref: '#/components/schemas/Platform' NetworkEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/NetworkEndpointTestResult' totalHits: $ref: '#/components/schemas/TotalHits' test: description: The scheduled test configuration. Omitted when the user lacks the `View endpoint experience tests` permission. allOf: - $ref: '#/components/schemas/EndpointScheduledTest' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' MultiTestIdNetworkEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/NetworkEndpointTestResult' totalHits: $ref: '#/components/schemas/TotalHits' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' NetworkEndpointTestResult: allOf: - $ref: '#/components/schemas/EndpointTestResult' - type: object properties: avgLatency: type: number description: Average RTT for packets sent to destination. example: 167.04 format: double readOnly: true errorDetails: type: string description: Error details, if an error was encountered. example: Error readOnly: true jitter: type: number description: Standard deviation of latency. example: 0.076808 format: double readOnly: true score: $ref: '#/components/schemas/EndpointPingDataPointScore' ztaMetrics: type: array items: $ref: '#/components/schemas/EndpointZtaMetrics' isIcmpBlocked: $ref: '#/components/schemas/IcmpBlocked' loss: type: number description: Percentage of packets not reaching destination. example: 0 format: double readOnly: true maxLatency: type: number description: Maximum RTT for packets sent to destination. example: 168 format: double readOnly: true minLatency: type: number description: Minimum RTT for packets sent to destination. example: 167 format: double readOnly: true SystemMetrics: type: object properties: startTimeMs: type: integer format: int64 description: The start time of metrics collection, expressed in milliseconds since the Epoch. example: 1581508857327 readOnly: true endTimeMs: type: integer format: int64 description: The end time of metrics collection, expressed in milliseconds since the Epoch. example: 1581508867333 readOnly: true cpuUtilization: $ref: '#/components/schemas/CpuUtilization' physicalMemoryUsedBytes: $ref: '#/components/schemas/PhysicalMemoryUsedBytes' physicalMemoryTotalBytes: type: integer format: int64 description: Total physical memory of the system. example: 1024 readOnly: true CpuUtilization: type: object properties: min: type: number format: double description: The minimum sampled usage value recorded during the monitored period. example: 0.22 minimum: 0 maximum: 1 readOnly: true max: type: number format: double description: The maximum sampled usage value recorded during the monitored period. example: 0.75 minimum: 0 maximum: 1 readOnly: true mean: type: number format: double description: The mean (average) sampled usage value recorded during the monitored period. example: 0.55 minimum: 0 maximum: 1 readOnly: true median: type: number format: double description: The median sampled usage value recorded during the monitored period. example: 0.61 minimum: 0 maximum: 1 readOnly: true stdDev: type: number format: double description: The standard deviation of sampled usage values recorded during the monitored period. example: 0.01 minimum: 0 maximum: 1 readOnly: true count: type: integer description: The total number of samples collected during the monitored period. example: 150 readOnly: true PhysicalMemoryUsedBytes: type: object properties: min: type: number format: double description: The minimum sampled memory usage value recorded during the monitored period. example: 1.2 readOnly: true max: type: number format: double description: The maximum sampled memory usage value recorded during the monitored period. example: 2.5 readOnly: true mean: type: number format: double description: The mean (average) value of memory usage sampled over the monitored period. example: 1.77 readOnly: true median: type: number format: double description: The median value of memory usage sampled over the monitored period. example: 1.85 readOnly: true stdDev: type: number format: double description: The standard deviation of memory usage sampled during the monitored period. example: 0.25 readOnly: true count: type: integer description: The total number of samples collected during the monitored period. example: 155 readOnly: true SystemMetricDetails: type: object description: 'Details of system metrics that contain top applications by CPU/memory usage. Not populated by default. ' properties: topCpuApplications: type: array description: A list of applications that consume more than 2% of the CPU. readOnly: true items: $ref: '#/components/schemas/ApplicationMetrics' topMemoryApplications: type: array description: A list of applications that consume more than 2% of the RAM. readOnly: true items: $ref: '#/components/schemas/ApplicationMetrics' ApplicationMetrics: type: object properties: name: type: string description: The name of the application. example: Webex totalCpu: type: number format: double description: The total CPU usage by all application processes. example: 0.5 totalMemoryPercentage: type: number format: double description: The total percentage of memory used by all application processes. example: 0.22 totalMemoryBytes: type: integer format: int64 description: The total memory in bytes used by all application processes. example: 1023334 processes: type: array description: A list of application processes. items: $ref: '#/components/schemas/ProcessMetrics' ProcessMetrics: type: object properties: name: type: string description: The name of the process. example: Webex background pid: type: integer description: The process ID. example: 15632 cpu: type: number format: double description: The CPU usage by the process as a percentage (e.g., 0.5 for 50% CPU usage). example: 0.5 memoryPercentage: type: number format: double description: The memory usage by the process as a percentage (e.g., 0.22 for 22%). example: 0.22 memoryBytes: type: integer format: int64 description: The memory usage by the process in bytes. example: 1023334 VpnProfile: type: object properties: vpnClientAddresses: type: array description: A list of private IP addresses assigned to the device by the VPN server. example: - 184.81.113.85 - 13.129.91.62 readOnly: true items: type: string vpnClientNetworkRange: type: array description: A list of private networks assigned to the device by the VPN server. readOnly: true items: type: string example: 9.88.37.27 vpnGatewayAddress: type: string description: IP address of the VPN gateway. example: 120.98.134.7 readOnly: true vpnType: $ref: '#/components/schemas/VpnType' TargetProfile: type: object properties: remotePort: type: integer description: The remote port of a network flow towards the target. example: 80 readOnly: true remoteIpAddress: type: string description: The remote IP address of a network flow towards the target. example: 120.98.134.7 readOnly: true protocol: $ref: '#/components/schemas/TestProtocol' PathVisEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/PathVisEndpointTestResult' test: description: The scheduled test configuration. Omitted when the user lacks the `View endpoint experience tests` permission. allOf: - $ref: '#/components/schemas/EndpointScheduledTest' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextAndSelfLink' PathVisEndpointTestResult: allOf: - $ref: '#/components/schemas/PathVisBaseEndpointTestResult' - type: object properties: location: type: string description: Geographic location of the path visualization. example: San Francisco Area readOnly: true pathTraces: type: array description: Shows an iteration of path trace, with each iteration specified by a pathId. items: $ref: '#/components/schemas/EndpointPathTrace' PathVisDetailEndpointTestResults: type: object properties: results: type: array items: $ref: '#/components/schemas/PathVisDetailEndpointTestResult' test: description: The scheduled test configuration. Omitted when the user lacks the `View endpoint experience tests` permission. allOf: - $ref: '#/components/schemas/EndpointScheduledTest' _links: $ref: '#/components/schemas/SelfLinks' PathVisDetailEndpointTestResult: allOf: - $ref: '#/components/schemas/PathVisBaseEndpointTestResult' - type: object properties: pathTraces: type: array description: Shows iterations of path trace, with each iteration specified by a pathId. items: $ref: '#/components/schemas/EndpointPathVisRoute' vpnPathTraces: type: array description: Shows iterations of the VPN path trace, with each iteration specified by a pathId. items: $ref: '#/components/schemas/EndpointPathVisRoute' PathVisBaseEndpointTestResult: allOf: - $ref: '#/components/schemas/EndpointTestResult' - type: object properties: asnDetails: $ref: '#/components/schemas/AsnDetails' server: type: string description: Target server, including port. example: www.google.com:443 readOnly: true sourceIp: type: string description: IP address of source endpoint agent. example: 196.40.106.237 readOnly: true sourcePrefix: type: string description: IP prefix of source endpoint agent. example: 196.40.96.0/20 readOnly: true AsnDetails: type: object properties: asName: type: string description: Name of the provider. example: ThousandEyes, Inc readOnly: true asNumber: type: integer description: Unique number assigned to an organization (also referred to as service provider). example: 394101 readOnly: true EndpointPathVisRoute: type: object properties: pathId: type: string description: Unique ID of path trace. example: '4711301366345855606023718047703941305741293841502186803' readOnly: true protocol: $ref: '#/components/schemas/EndpointTestResultProtocol' tcpPathTraceMode: $ref: '#/components/schemas/TcpPathTraceModeResponse' udpPathTraceMode: $ref: '#/components/schemas/UdpPathTraceModeResponse' hops: type: array description: Array of hop objects indicating each step in the traceroute. items: $ref: '#/components/schemas/EndpointPathVisHop' EndpointPathVisHop: allOf: - $ref: '#/components/schemas/Hop' - type: object properties: rdns: type: string description: Reverse DNS entry of IP, if available. example: core-router1.cpt2.host-h.net readOnly: true network: type: string description: Autonomous System originating the prefix. example: HETZNER (Pty) Ltd (AS 37153) readOnly: true responseTime: type: integer description: RTT to the hop’s IP in milliseconds. example: 1 readOnly: true location: type: string description: Location information for the hop. example: Cape Town, South Africa readOnly: true Hop: type: object properties: hop: type: integer description: The hop index. example: 1 readOnly: true ipAddress: type: string description: IP address of the hop. example: 196.40.106.237 readOnly: true prefix: type: string description: Prefix of IP address shown in CIDR. example: 196.40.96.0/20 readOnly: true EndpointPathTrace: type: object properties: ipAddress: type: string description: IP address of the hop destination. example: 196.40.106.237 readOnly: true numberOfHops: type: integer description: Number of hops for path trace to destination. example: 15 readOnly: true protocol: $ref: '#/components/schemas/EndpointTestResultProtocol' tcpPathTraceMode: $ref: '#/components/schemas/TcpPathTraceModeResponse' udpPathTraceMode: $ref: '#/components/schemas/UdpPathTraceModeResponse' pathId: type: string description: Unique ID of path trace. example: '1230899668701775614109128428722974545787322404682781961521' readOnly: true responseTime: type: integer description: RTT of the path trace to the destination in milliseconds. example: 1500 readOnly: true HttpMultiEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/HttpEndpointTestResult' totalHits: $ref: '#/components/schemas/TotalHits' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextAndSelfLink' HttpEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/HttpEndpointTestResult' totalHits: $ref: '#/components/schemas/TotalHits' test: description: The scheduled test configuration. Omitted when the user lacks the `View endpoint experience tests` permission. allOf: - $ref: '#/components/schemas/EndpointHttpServerTest' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextAndSelfLink' HttpEndpointTestResult: allOf: - $ref: '#/components/schemas/EndpointTestResult' - type: object properties: score: $ref: '#/components/schemas/EndpointHttpDataPointScore' connectTime: type: integer description: Time required to establish a TCP connection to the server in milliseconds. example: 2 readOnly: true dnsTime: type: integer description: Time required to resolve DNS in milliseconds. example: 0 readOnly: true errorType: $ref: '#/components/schemas/HttpErrorType' errorDetails: type: string description: Error details, if an error were encountered. readOnly: true headers: $ref: '#/components/schemas/HttpEndpointTestResultHeaders' numRedirects: type: integer description: Number of redirects. example: 0 readOnly: true receiveTime: type: integer description: Elapsed time between first and last byte of response in milliseconds. example: 1 readOnly: true redirectTime: type: integer description: Cumulative redirect timing in milliseconds. example: 10 readOnly: true responseCode: type: integer description: HTTP response code. example: 200 readOnly: true responseTime: type: integer description: Time to first byte in milliseconds. example: 14 readOnly: true serverIp: type: string description: IP address of destination server. example: 193.2.1.88 readOnly: true sslTime: type: integer description: Time to negotiate SSL/TLS in milliseconds. example: 9 readOnly: true totalTime: type: integer description: Total time is the response time + receive time. example: 15 readOnly: true waitTime: type: integer description: Time elapsed between completion of request and first byte of response in milliseconds. example: 3 readOnly: true wireSize: type: integer description: Size of content in bytes. example: 9993 readOnly: true throughput: type: integer description: Amount of data transmitted, in bytes. example: 190 readOnly: true HttpErrorType: type: string enum: - connect - dns - http - none - send - ssl - receive description: Type of error encountered; corresponds to phase of connection. default: connect example: connect readOnly: true HttpEndpointTestResultHeaders: type: object description: Expandable object containing both request and response headers. properties: requestHeaders: type: string description: 'CRLF-delimited list of request headers in `header: value` format.' example: "GET / HTTP/1.1\r\nHost: www.thousandeyes.com\r\nUser-Agent: curl/7.58.0-DEV\r\nAccept: */*\r\nAccept-Encoding:\ \ deflate, gzip\r\nX-ThousandEyes-Agent: yes\r\n" readOnly: true responseHeaders: type: string description: 'CRLF-delimited list of response headers in `header: value` format.' example: "HTTP/1.1 200 OK\r\nContent-Type: text/html;charset=UTF-8\r\nContent-Length: 9993\r\nConnection: keep-alive\r\ \nDate: Mon, 04 May 2020 16:13:00 GMT\r\nServer: Apache\r\nContent-Language: en-US\r\nContent-Encoding: gzip\r\ \nX-Frame-Options: sameorigin\r\nCache-Control: max-age=600, must-revalidate\r\nStrict-Transport-Security: max-age=31536000\r\ \nX-Content-Type-Options: nosniff\r\nX-XSS-Protection: 1; mode=block\r\nVary: Accept-Encoding\r\nX-Cache: Hit\ \ from cloudfront\r\nVia: 1.1 7ba3caf71ae7a52dd411d1a543e80cd8.cloudfront.net (CloudFront)\r\nX-Amz-Cf-Pop: SFO5-C3\r\ \nX-Amz-Cf-Id: w4h42tkoJD-rEpkRDZUvnQBmy26GVGe6pUsuRr1Dphf7oajYbjXaOA==\r\nAge: 132\r\n" readOnly: true NetworkDynamicEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/NetworkDynamicEndpointTestResult' test: $ref: '#/components/schemas/DynamicTest' totalHits: $ref: '#/components/schemas/TotalHits' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' NetworkDynamicEndpointTestResult: allOf: - $ref: '#/components/schemas/NetworkEndpointTestResult' - $ref: '#/components/schemas/DynamicBaseEndpointTestResult' DynamicEndpointTestWebex: type: object description: Contains object with webex information. Only returned for webex applications. properties: conferenceId: type: string description: Webex conference ID. example: '225817074608419375' readOnly: true correlationId: type: string format: uuid description: Webex conference correlation ID. example: 4e57c97e-abdf-4ec8-a78c-95bac9719896 readOnly: true localSipSessionId: type: string description: Webex calling local sip session ID. example: c124ba2b012050008000aa0c26c4bf0f readOnly: true meetingApp: type: string description: RoomOS meeting app. example: ZoomCRC readOnly: true remoteSipSessionId: type: string description: Webex calling remote sip session ID. example: '22581707460321454' readOnly: true DynamicBaseEndpointTestResult: type: object properties: application: $ref: '#/components/schemas/DynamicTestApplication' protocol: $ref: '#/components/schemas/EndpointTestResultProtocol' tcpProbeMode: $ref: '#/components/schemas/TestProbeModeResponse' udpProbeMode: $ref: '#/components/schemas/UdpProbeModeResponse' webex: $ref: '#/components/schemas/DynamicEndpointTestWebex' PathVisDynamicEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/PathVisDynamicEndpointTestResult' test: $ref: '#/components/schemas/DynamicTest' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' totalHits: $ref: '#/components/schemas/TotalHits' _links: $ref: '#/components/schemas/PaginationNextAndSelfLink' PathVisDynamicEndpointTestResult: allOf: - $ref: '#/components/schemas/PathVisBaseEndpointTestResult' - $ref: '#/components/schemas/DynamicBaseEndpointTestResult' - type: object properties: location: type: string description: Geographic location of the path visualization. example: San Francisco Area readOnly: true pathTraces: type: array description: Shows an iteration of path trace, with each iteration specified by a pathId. items: $ref: '#/components/schemas/EndpointPathTrace' PathVisDetailDynamicEndpointTestResults: type: object properties: results: type: array items: $ref: '#/components/schemas/PathVisDetailDynamicEndpointTestResult' test: $ref: '#/components/schemas/DynamicTest' _links: $ref: '#/components/schemas/SelfLinks' PathVisDetailDynamicEndpointTestResult: allOf: - $ref: '#/components/schemas/PathVisDetailEndpointTestResult' - $ref: '#/components/schemas/DynamicBaseEndpointTestResult' EndpointResultRequestFilter: type: object properties: location: type: array description: Location of the endpoint agent. items: type: string example: - San Francisco Bay Area - Germany connection: type: array items: $ref: '#/components/schemas/InterfaceHardwareType' platform: type: array items: $ref: '#/components/schemas/Platform' gateway: type: array description: Endpoint agent default gateway IP address. items: type: string example: - 78.153.54.204 - 78.153.54.206 proxyTarget: type: array description: Endpoint agent proxy IP address. items: type: string example: - 78.153.54.204 - 78.153.54.206 vpnTarget: type: array description: Endpoint agent VPN endpoint IP address. items: type: string example: - 78.153.54.204 - 78.153.54.206 agentId: type: array description: Endpoint agent ID. items: type: string format: uuid example: - 3fde6422-f119-40e1-ae32-d08a1243c038 - 236e6f18-9637-4a2f-b15f-7aa6a29c9fce networkId: type: array description: Network ID. items: type: string example: - 660b34109d12 - 660b34109d15 ssid: type: array description: WiFi SSID. items: type: string example: - wifi-name - other-room-wifi bssid: type: array description: WiFi BSSID. items: type: string example: - 8c:68:c8:a5:0a:8c - 0c:51:01:e4:3e:d0 nicModel: $ref: '#/components/schemas/NicModelFilter' nicDriverVersion: $ref: '#/components/schemas/NicDriverVersionFilter' RealUserEndpointTestResultsRequest: type: object properties: searchFilters: $ref: '#/components/schemas/RealUserEndpointTestResultRequestFilter' RealUserEndpointTestResultRequestFilter: allOf: - $ref: '#/components/schemas/EndpointResultRequestFilter' - type: object properties: destinationIp: type: array description: Web site destination IP address. items: type: string example: - 84.255.241.1 - 193.2.1.88 domain: type: array description: Web site base domain visited during the session. items: type: string example: - thousandeyes.com trigger: type: array description: Real user test trigger. items: $ref: '#/components/schemas/Trigger' example: - user visitedSite: type: array description: Web site domain visited during the session. items: type: string example: - app.thousandeyes.com Trigger: type: string enum: - auto - user example: auto RealUserEndpointTestBase: allOf: - type: object properties: agentId: $ref: '#/components/schemas/EndpointAgentId' committed: type: string format: date-time description: UTC date when endpoint real user test was committed to the controller (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true date: type: string format: date-time description: UTC date when endpoint real user test took place (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true experienceScore: type: number format: double description: Score rating a user’s experience when loading a particular page, from 0 (the worst) to 1 (the best). [More details](https://docs.thousandeyes.com/product-documentation/end-user-monitoring/viewing-data/endpoint-agent-views-reference#user-experience-score). minimum: 0 maximum: 1 example: 0.5 readOnly: true numberOfPages: type: integer description: Number of web pages visited on target website. example: 2 readOnly: true organizationName: type: string description: Name of the AS organization `sourceAddress` belongs to. example: T-2 Access Network readOnly: true port: type: integer description: Port used to visit target website. example: 443 readOnly: true protocol: type: string description: Protocol used to visit target website. example: https readOnly: true roundId: $ref: '#/components/schemas/RoundId' sourceAddress: type: string description: Public IP address of the endpoint agent during the session. example: 84.255.241.1 readOnly: true id: type: string description: Endpoint real user test ID. Each endpoint real user test occurrence has a unique ID. example: 07625:1490529480:aVDViw0i readOnly: true visitedSite: type: string description: Domain used to visit target website. example: www.thousandeyes.com readOnly: true RealUserEndpointTest: allOf: - $ref: '#/components/schemas/RealUserEndpointTestBase' - type: object properties: pageId: $ref: '#/components/schemas/EndpointPageId' EndpointPageId: type: string description: Web page ID. The page ID is unique only within an endpoint real user test. example: C31gBrYJ readOnly: true RealUserEndpointTestResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/RealUserEndpointTest' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' RealUserEndpointTestDetail: allOf: - $ref: '#/components/schemas/RealUserEndpointTestBase' - type: object properties: browser: $ref: '#/components/schemas/EndpointBrowser' coordinates: $ref: '#/components/schemas/RealUserEndpointTestCoordinates' pages: type: array description: Web site base domain visited during the session. items: $ref: '#/components/schemas/RealUserEndpointTestPage' network: $ref: '#/components/schemas/RealUserEndpointTestNetwork' RealUserEndpointTestDetailResults: type: object properties: results: type: array items: $ref: '#/components/schemas/RealUserEndpointTestDetail' _links: $ref: '#/components/schemas/SelfLinks' EndpointBrowser: type: object properties: name: type: string description: Browser name. example: Google Chrome readOnly: true version: type: string description: Browser version. example: 116.0.0.0 readOnly: true RealUserEndpointTestCoordinates: type: object description: Contains approximate GPS location of the endpoint agent, based on endpoint agent’s public IP address. properties: latitude: type: number format: double description: Numeric representations of GPS coordinates. example: 46.0552778 readOnly: true location: type: string description: Represents named geographical location. example: Slovenia readOnly: true longitude: type: number format: double description: Numeric representations of GPS coordinates. example: 14.5144444 readOnly: true RealUserEndpointTestPageTimings: type: object properties: onContentLoad: type: integer description: DOM load time in milliseconds. example: 1483 readOnly: true onLoad: type: integer description: Page load time in milliseconds. example: 4569 readOnly: true RealUserEndpointTestPage: type: object properties: pageId: $ref: '#/components/schemas/EndpointPageId' pageTitle: type: string description: Web page title. example: Network Performance Resources | ThousandEyes readOnly: true pageUrl: type: string description: Web page url example: https://app.thousandeyes.com/settings/integrations readOnly: true loadDate: type: string format: date-time description: UTC date when page load started (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true responseCode: type: integer description: HTTP response code. example: 200 readOnly: true pageTimings: $ref: '#/components/schemas/RealUserEndpointTestPageTimings' RealUserEndpointTestNetwork: type: object description: Contains details about network profile and conditions during session. properties: networkProfile: $ref: '#/components/schemas/NetworkProfile' systemMetrics: $ref: '#/components/schemas/SystemMetrics' gatewayPing: $ref: '#/components/schemas/GatewayNetworkPing' ping: $ref: '#/components/schemas/TargetNetworkPing' traceroute: $ref: '#/components/schemas/TargetTraceroute' connectRtt: type: number format: double description: Represents the number of milliseconds required to establish TCP connectivity with the target. example: 77.777 readOnly: true isIcmpBlocked: $ref: '#/components/schemas/IcmpBlocked' errors: type: array description: Array of string representing possible network errors. items: type: string example: - 'ping: Request timed out before getting response' readOnly: true vpnPing: $ref: '#/components/schemas/VpnNetworkPing' vpnTraceroute: $ref: '#/components/schemas/VpnTraceroute' NetworkInterface: type: object properties: ipAddress: type: string description: Network IP address. example: 10.0.0.13 readOnly: true subnetMask: type: string description: Network subnet mask - only for IPv4. example: 255.255.255.0 readOnly: true publicIpAddress: type: string description: Network public IP address. example: 84.255.241.1 readOnly: true localPrefix: type: string description: Network local prefix. example: 10.0.0.0 readOnly: true publicIpRange: type: string description: Network public IP range. example: 84.255.241.0-84.255.241.255 readOnly: true dnsServers: type: array description: Network DNS servers. example: - 8.8.8.8 - 8.8.8.4 readOnly: true items: type: string hardwareType: $ref: '#/components/schemas/InterfaceHardwareType' interfaceName: type: string description: Network interface name. example: en0 readOnly: true NetworkProfile: allOf: - $ref: '#/components/schemas/NetworkInterface' - type: object description: Contains basic network connectivity parameters. properties: error: type: string description: Only present when there is an error example: An operation timed out. readOnly: true gateway: type: string description: Network gateway address. example: 10.0.0.1 readOnly: true wirelessProfile: $ref: '#/components/schemas/NetworkWirelessProfile' proxyProfile: $ref: '#/components/schemas/NetworkProxyProfile' ethernetProfile: $ref: '#/components/schemas/EndpointTestEthernetProfile' previousInterface: $ref: '#/components/schemas/NetworkInterface' NetworkWirelessProfile: type: object properties: ssid: type: string description: Wireless network SSID. example: Internet for the masses readOnly: true bssid: type: string description: Wireless network BSSID. example: 4c:ba:ba:f4:fa:fa readOnly: true channel: type: integer description: Wireless network channel. example: 1 readOnly: true phyMode: type: string description: Wireless network PHY mode. example: 802.11n readOnly: true rssi: type: integer description: Wireless network RSSI. example: -38 readOnly: true noise: type: integer description: Wireless network noise. example: -95 readOnly: true snr: type: integer description: Wireless network signal-to-noise ratio (SNR), in dB. example: 57 readOnly: true quality: type: integer description: Wireless network quality. example: 100 readOnly: true txRate: type: integer description: Wireless network transmitted rate. example: 130 readOnly: true vendor: type: string description: Wireless network device vendor. example: Cisco readOnly: true NetworkProxy: type: object properties: bypass: type: string description: Proxy bypass expression. example: '*.local;169.254/16' readOnly: true proxy: type: string description: Proxy mode. example: readOnly: true NetworkProxyProfile: type: object properties: method: type: string description: Proxy profile method. example: System readOnly: true proxies: type: array items: $ref: '#/components/schemas/NetworkProxy' EndpointTestEthernetProfile: type: object properties: linkSpeed: type: integer description: Ethernet profile link speed example: 860 readOnly: true NetworkPing: type: object properties: avgRtt: type: integer description: Ping average response time. example: 7 readOnly: true maxRtt: type: integer description: Ping maximum response time. example: 66 readOnly: true loss: type: number format: double description: Network loss. example: 1 readOnly: true meanDevRtt: type: integer description: Ping mean standard deviation response time. example: 11 readOnly: true minRtt: type: integer description: Ping minimum response time. example: 1 readOnly: true pktsReceived: type: integer description: Ping packets received. example: 10 readOnly: true pktsSent: type: integer description: Ping packets sent. example: 10 readOnly: true error: type: string description: Only present when there is an error. example: An operation timed out. readOnly: true infoFlags: $ref: '#/components/schemas/ErrorFlags' GatewayNetworkPing: allOf: - description: Contains numeric parameters representing results of a ping test performed against the endpoint agent default gateway. - $ref: '#/components/schemas/NetworkPing' TargetNetworkPing: allOf: - description: Contains number parameters representing results of a ping test performed against the target website. - $ref: '#/components/schemas/NetworkPing' VpnNetworkPing: allOf: - description: Contains number parameters representing results of a ping test performed against the target website on the VPN. - $ref: '#/components/schemas/NetworkPing' TracerouteHop: allOf: - $ref: '#/components/schemas/Hop' - type: object properties: asn: type: integer description: Unique number assigned to an organization (also referred to as service provider). example: 34779 readOnly: true delay: type: integer description: Hop delay example: 5 readOnly: true mpls: type: array description: Hop Multiprotocol Label Switching. items: type: string example: - L=301472,E=0,S=1,T=1 readOnly: true name: type: string description: The hop name. example: 89-210-88-65.access.t-2.net readOnly: true Traceroute: type: object properties: destination: type: string description: The target IP address. example: 13.32.22.232 readOnly: true error: type: string description: Only present when there is an error example: An operation timed out. readOnly: true infoFlags: $ref: '#/components/schemas/ErrorFlags' internalErrors: $ref: '#/components/schemas/ErrorFlags' hops: type: array items: $ref: '#/components/schemas/TracerouteHop' TargetTraceroute: allOf: - description: Contains parameters representing results of a trace route test performed against the target. - $ref: '#/components/schemas/Traceroute' UserProfile: type: object description: Details of the logged-in user, including username and user principal name. properties: userName: type: string description: Machine username of the logged-in user. example: joeblogs32 userPrincipalName: $ref: '#/components/schemas/UserPrincipalName' UserPrincipalNameFilter: description: Filters results based on an array of `userPrincipalName` values. type: array items: $ref: '#/components/schemas/UserPrincipalName' NicModelFilter: description: Filters results to NIC models that exactly match one of the provided values. Matching is case-sensitive. type: array items: type: string example: Intel(R) Wi-Fi 6 AX200 160MHz NicDriverVersionFilter: description: Filters results to NIC driver versions that exactly match one of the provided values. Matching is case-sensitive. type: array items: type: string example: 22.250.0.9 VpnTraceroute: allOf: - description: Contains parameters representing results of a trace route test performed against the target on the VPN. - $ref: '#/components/schemas/Traceroute' RealUserEndpointTestPageResult: allOf: - $ref: '#/components/schemas/RealUserEndpointTestPage' - type: object properties: agentId: $ref: '#/components/schemas/EndpointAgentId' id: type: string description: Endpoint real user test ID. Each endpoint real user test occurrence has a unique ID. example: 07625:1490529480:aVDViw0i readOnly: true roundId: $ref: '#/components/schemas/RoundId' responseTime: type: integer description: HTTP server response in milliseconds. example: 240 readOnly: true systemMetrics: $ref: '#/components/schemas/SystemMetrics' RealUserEndpointTestPageResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/RealUserEndpointTestPageResult' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' RealUserEndpointTestPageDetailResult: type: object properties: har: $ref: '#/components/schemas/RealUserEndpointTestPageHar' _links: $ref: '#/components/schemas/SelfLinks' RealUserEndpointTestPageHar: type: object description: A HAR object according to the [HTTP Archive 1.2 specifications](http://www.softwareishard.com/blog/har-12-spec/), with an additional `systemMetrics` property. example: log: browser: name: Google Chrome version: 57.0.2987.98 creator: name: ThousandEyes Endpoint Agent version: 0.47.0 entries: - pageref: page_1 request: headers: - name: Upgrade-Insecure-Requests value: '1' - name: User-Agent value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.98 Safari/537.36 - name: Accept value: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8 - name: Referer value: https://www.thousandeyes.com/ - name: Accept-Encoding value: gzip, deflate, sdch, br - name: Accept-Language value: en-US,en;q=0.6 - name: Cookie value: (removed) method: GET queryString: - name: locale value: en-US url: https://www.thousandeyes.com/resources response: bodySize: 17776 content: mimeType: text/html;charset=ISO-8859-1 size: 17776 headers: - name: Content-Type value: text/html;charset=ISO-8859-1 - name: Content-Length value: '17776' - name: Connection value: keep-alive - name: Date value: Sun, 26 Mar 2017 11:58:54 GMT - name: Server value: Apache - name: Cache-Control value: max-age=600, must-revalidate - name: Content-Language value: en-US - name: Content-Encoding value: gzip - name: X-Frame-Options value: sameorigin - name: Strict-Transport-Security value: max-age=31536000 - name: Vary value: Accept-Encoding - name: X-Cache value: Miss from cloudfront - name: Via value: 1.1 5dbe09af3a2c87121e31ffa67f174f66.cloudfront.net (CloudFront) - name: X-Amz-Cf-Id value: YkvlkBNKgHt5aMu9vcS22Z8kHn1MUr-8adupwhDk3j9vF-TpSyIxZA== headersSize: 527 redirectURL: '' status: 200 statusText: OK serverIPAddress: 13.32.22.80 startedDateTime: '2017-03-22T11:58:54.123+02:00' time: 177 timings: blocked: -1 connect: -1 dns: -1 receive: 27 send: -1 ssl: -1 wait: 150 - pageref: page_1 request: headers: - name: User-Agent value: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/57.0.2987.98 Safari/537.36 - name: Accept value: '*/*' - name: Referer value: https://www.thousandeyes.com/resources - name: Accept-Encoding value: gzip, deflate, sdch, br - name: Accept-Language value: en-US,en;q=0.6 method: GET queryString: [] url: https://use.typekit.net/cjy5myw.js response: bodySize: 0 content: mimeType: text/javascript;charset=utf-8 size: 7814 headers: - name: status value: '200' - name: access-control-allow-origin value: '*' - name: cache-control value: public, max-age=600, stale-while-revalidate=604800 - name: content-encoding value: gzip - name: content-type value: text/javascript;charset=utf-8 - name: server value: nginx - name: status value: 200 OK - name: timing-allow-origin value: '*' - name: vary value: Accept-Encoding - name: content-length value: '7814' - name: date value: Sun, 26 Mar 2017 11:58:43 GMT headersSize: 334 redirectURL: '' status: 200 statusText: OK serverIPAddress: 104.103.103.234 startedDateTime: '2017-03-22T11:58:54.123+02:00' time: 72 timings: blocked: -1 connect: -1 dns: -1 receive: 10 send: -1 ssl: -1 wait: 62 pages: - id: page_1 pageTimings: onContentLoad: 874 onLoad: 3492 responseCode: 200 startedDateTime: '2017-03-22T11:58:54.123+02:00' title: Network Performance Resources | ThousandEyes version: '1.2' systemMetrics: startTimeMs: 1581508857327 endTimeMs: 1581508867333 cpuUtilization: min: 0.30859375 max: 0.5625 mean: 0.38931831001805056 median: 0.353515625 stdDev: 0.08389194281742307 count: 10 physicalMemoryUsedBytes: min: 12805128192 max: 12825530368 mean: 12819145821.09091 median: 12818219008 stdDev: 5741124.05691331 count: 11 physicalMemoryTotalBytes: 17069891584 RealUserEndpointTestNetworkResult: type: object properties: agentId: $ref: '#/components/schemas/EndpointAgentId' date: type: string format: date-time description: UTC date when endpoint real user test took place (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true id: type: string description: Endpoint real user test ID. Each endpoint real user test occurrence has a unique ID. example: 07625:1490529480:aVDViw0i readOnly: true roundId: $ref: '#/components/schemas/RoundId' destination: $ref: '#/components/schemas/NetworkMetrics' vpn: $ref: '#/components/schemas/NetworkMetrics' proxy: $ref: '#/components/schemas/NetworkMetrics' systemMetrics: $ref: '#/components/schemas/SystemMetrics' NetworkMetrics: type: object properties: jitter: type: integer description: Network jitter. example: 46 readOnly: true latency: type: integer description: Network latency. example: 150 readOnly: true loss: type: number format: double description: Network loss. example: 0.1 readOnly: true target: type: string description: Network target IP address. example: 54.208.6.220 readOnly: true RealUserEndpointTestNetworkResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/RealUserEndpointTestNetworkResult' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' EndpointNetworkTopologyResultRequest: type: object properties: thresholdFilter: $ref: '#/components/schemas/EndpointNetworkTopologyThresholdFilter' searchFilters: $ref: '#/components/schemas/EndpointNetworkTopologyResultRequestFilter' EndpointNetworkTopologyThresholdFilter: type: object description: Applies all filters using the specified conditional operator (AND or OR). properties: filters: type: array items: $ref: '#/components/schemas/LocalNetworksThresholdFilter' conditionalOperator: $ref: '#/components/schemas/ConditionalOperator' LocalNetworksThresholdFilter: type: object description: Filters the metric using the specified operator and threshold value. properties: name: $ref: '#/components/schemas/LocalNetworksThresholdFilterName' value: type: number description: The threshold value. format: double example: 10 operator: $ref: '#/components/schemas/ThresholdFilterOperator' LocalNetworksThresholdFilterName: type: string description: Metric on which the threshold filter is applied. enum: - vpn-score - avg-rtt - mean-dev-rtt - loss example: loss EndpointNetworkTopologyResultRequestFilter: allOf: - $ref: '#/components/schemas/EndpointResultRequestFilter' - type: object properties: type: type: array description: Web site base domain visited during the session. items: $ref: '#/components/schemas/NetworkTopologyType' example: - vpn - proxy NetworkTopologyType: type: string enum: - vpn - proxy - gateway - dns - unknown example: vpn LocalNetworkTopologyResultBase: type: object properties: agentId: $ref: '#/components/schemas/EndpointAgentId' date: type: string format: date-time description: UTC date when endpoint network topology took place (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true networkTopologyId: type: string description: Network topology ID. Each network topology occurrence has a unique ID. example: 00160:54c3a4b180c6:1490536500:c7a58c49 readOnly: true dnsServerTest: $ref: '#/components/schemas/LocalNetworkTopologyDnsServerTest' roundId: $ref: '#/components/schemas/RoundId' target: type: string description: IP of the target the network topology was performed against. This is typically a default gateway, proxy or VPN endpoint. example: 10.0.2.2 readOnly: true targetPort: type: integer description: Port of the target the network topology was performed against. example: 80 readOnly: true type: $ref: '#/components/schemas/NetworkTopologyType' icmpPing: $ref: '#/components/schemas/NetworkPing' isIcmpBlocked: $ref: '#/components/schemas/IcmpBlocked' tcpConnect: $ref: '#/components/schemas/TcpConnect' systemMetrics: $ref: '#/components/schemas/SystemMetrics' systemMetricDetails: $ref: '#/components/schemas/SystemMetricDetails' vpnScore: $ref: '#/components/schemas/EndpointProbeVpnScore' gatewayScore: $ref: '#/components/schemas/EndpointProbeGatewayScore' proxyScore: $ref: '#/components/schemas/EndpointProbeProxyScore' connectionScore: $ref: '#/components/schemas/EndpointProbeConnectionScore' agentScore: $ref: '#/components/schemas/EndpointProbeAgentScore' batteryMetrics: $ref: '#/components/schemas/BatteryMetrics' cellularProfile: $ref: '#/components/schemas/CellularProfile' platform: $ref: '#/components/schemas/Platform' LocalNetworkTopologyDnsServerTest: type: object description: DNS server test details. This object is only available when the topology `type` is `dns`. properties: resolutionTime: type: integer description: How long it took to resolve the DNS query in milliseconds. example: 3 readOnly: true LocalNetworkTopologyResults: type: object properties: results: x-paginated-items: true type: array items: $ref: '#/components/schemas/LocalNetworkTopologyResultBase' startDate: $ref: '#/components/schemas/StartDate' endDate: $ref: '#/components/schemas/EndDate' _links: $ref: '#/components/schemas/PaginationNextLink' LocalNetworkResult: type: object properties: networkId: type: string description: The network ID. Each network occurrence has a unique ID. example: 006c4fa7a054 readOnly: true networkName: type: string description: The network name. example: 10.5.51.0 (in 178.216.56.0/21) readOnly: true localPrefix: type: string description: Network local private address. example: 10.5.51.0 readOnly: true publicIpRange: type: string description: Network public IP range. example: 178.216.56.0-178.216.63.255 readOnly: true LocalNetworkResults: type: object properties: localNetworks: type: array items: $ref: '#/components/schemas/LocalNetworkResult' _links: $ref: '#/components/schemas/SelfLinks' LocalNetworkTopologyResult: allOf: - $ref: '#/components/schemas/LocalNetworkTopologyResultBase' - type: object properties: coordinates: $ref: '#/components/schemas/RealUserEndpointTestCoordinates' networkProfile: $ref: '#/components/schemas/NetworkProfile' icmpTraceroute: $ref: '#/components/schemas/Traceroute' icmpTraceroutes: type: array items: $ref: '#/components/schemas/Traceroute' LocalNetworkTopologyDetailResults: type: object properties: results: type: array items: $ref: '#/components/schemas/LocalNetworkTopologyResult' _links: $ref: '#/components/schemas/SelfLinks' IcmpBlocked: type: boolean description: Set to `true` if network target is blocking ICMP echo (ping) queries. example: true readOnly: true EndpointZtaSegmentType: type: string description: Type of ZTA segment. enum: - zta_ingress - zta_service example: zta_service EndpointZtaMetrics: type: object properties: loss: type: number format: double description: Percentage of packets that failed to reach the destination. example: 50 avgLatency: type: integer format: int64 description: Average latency in milliseconds. example: 3 jitter: type: integer format: int64 description: Standard deviation of latency in milliseconds. example: 5 errorMessage: type: string description: Error message if an error occurred. example: ERR_NAME_NOT_RESOLVED type: $ref: '#/components/schemas/EndpointZtaSegmentType' EndpointPingDataPointScore: type: object properties: applicationScore: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointHttpDataPointScore: type: object properties: applicationScore: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointProbeAgentScore: type: object properties: score: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointProbeVpnScore: type: object properties: score: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointProbeGatewayScore: type: object properties: score: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointProbeConnectionScore: type: object properties: score: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointProbeProxyScore: type: object properties: score: $ref: '#/components/schemas/EndpointScoreNumeric' quality: $ref: '#/components/schemas/ApplicationScoreQuality' EndpointScoreNumeric: type: number format: double description: A fine-grained score between 0 and 100. example: 100 ApplicationScoreQuality: type: string enum: - great - good - poor example: great TcpConnect: type: object properties: rtt: type: number format: double description: Represents the number of milliseconds required to establish TCP connectivity with the target example: 77.777 readOnly: true errorCode: type: string description: Only present when there is an error example: ERR_TIMED_OUT readOnly: true error: type: string description: Only present when there is an error example: An operation timed out. readOnly: true infoFlags: $ref: '#/components/schemas/ErrorFlags' ErrorFlags: type: array items: type: string example: - TE_INFO_ICMP_BLOCKED_BY_FIREWALL readOnly: true ExpandEndpointHttpServerOptions: type: string enum: - header - user-profile example: header ExpandEndpointNetworkOptions: type: string enum: - user-profile example: user-profile ExpandEndpointDynamicNetworkOptions: type: string enum: - user-profile example: user-profile ExpandLocalNetworkTopologyOptions: type: string enum: - system-metric-detail - user-profile example: system-metric-detail TotalHits: description: Total number of measurements that match the search criteria. type: integer example: 12 UnauthorizedError: type: object properties: error: type: string example: invalid_token error_description: type: string example: Invalid access token Error: type: object properties: type: type: string description: A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank". title: type: string description: A short, human-readable summary of the problem type. status: type: integer description: The HTTP status code generated by the origin server for this occurrence of the problem. detail: type: string description: A human-readable explanation specific to this occurrence of the problem. instance: type: string description: A URI reference that identifies the specific occurrence of the problem. ValidationErrorItem: type: object properties: code: type: string description: (Optional) A unique error type/code that can be referenced in the documentation for further details. field: type: string description: Identifies the field that triggered this particular error. message: type: string description: A short, human-readable summary of the error. ValidationError: type: object allOf: - $ref: '#/components/schemas/Error' - type: object properties: errors: nullable: true type: array description: (Optional) When multiple errors occur, the details for each error are listed. items: $ref: '#/components/schemas/ValidationErrorItem' SortOrder: type: string example: desc description: Parameter indicates the ascending/descending order of the sorting, using either the asc or desc values. enum: - asc - desc ConditionalOperator: type: string enum: - and - or example: and ThresholdFilterOperator: type: string enum: - gte - lte example: gte AccountGroupId: type: string description: A unique identifier associated with your account group. You can retrieve your `AccountGroupId` from the `/account-groups` endpoint. example: '1234' EndpointAgentId: type: string format: uuid description: Unique ID of endpoint agent, from `/endpoint/agents` endpoint. example: 861b7557-cd57-4bbb-b648-00bddf88ef49 readOnly: true BatteryLevel: description: Battery level indicator. type: string example: medium enum: - high - medium - low BatteryMetrics: description: Battery metrics for the endpoint agent. type: object readOnly: true properties: batteryHealthNormalizedPercent: type: number format: double description: Battery health as a normalized percentage (0-1). example: 0.92 minimum: 0 maximum: 1 batteryLevel: $ref: '#/components/schemas/BatteryLevel' batteryLevelNormalizedPercent: type: number format: double description: Battery level as a normalized percentage (0-1). example: 0.3 minimum: 0 maximum: 1 required: - batteryLevel - batteryLevelNormalizedPercent CellularNetworkGen: description: Cellular network generation. type: string example: 2g, 3g, 4g, 5g CellularProfile: description: Cellular network profile information for a mobile endpoint agent. type: object readOnly: true properties: carrierName: type: string description: Carrier name example: T-Mobile networkGen: $ref: '#/components/schemas/CellularNetworkGen' networkSubtype: type: string description: A real network subtype. It may be different from an advertised network type. example: LTE/HSPA advertisedNetworkGen: $ref: '#/components/schemas/CellularNetworkGen' advertisedNetworkSubtype: type: string description: Advertised Network subtype example: LTE/HSPA rssi: type: number format: double description: Received Signal Strength Indicator in dBm. Values are always negative. example: -10 rsrp: type: number format: double description: Reference Signal Received Power in dBm. Values are always negative. example: -30 rscp: type: number format: double description: Received Signal Code Power in dBm. Values are always negative or zero. example: -30 rsrq: type: number format: double description: Reference Signal Received Quality in dBm. Values are always negative. example: -30 sinr: type: number format: double description: Signal to Interference and Noise Ratio in dBm. It can be negative or positive. example: 20 Platform: description: OS platform types. Platform "linux" was recently renamed to "roomos". type: string enum: - windows - roomos - phoneos - elux - cisco-wireless - cisco-wireless-cloud - linux - mac - android - unknown example: mac Link: type: object description: A hyperlink from the containing resource to a URI. required: - href properties: href: type: string description: Its value is either a URI [RFC3986] or a URI template [RFC6570]. example: https://api.thousandeyes.com/v7/link/to/resource/id templated: type: boolean description: Should be true when the link object's "href" property is a URI template. type: type: string description: Used as a hint to indicate the media type expected when dereferencing the target resource. deprecation: type: string description: Its presence indicates that the link is to be deprecated at a future date. Its value is a URL that should provide further information about the deprecation. name: type: string description: Its value may be used as a secondary key for selecting link objects that share the same relation type. profile: type: string description: A URI that hints about the profile of the target resource. title: type: string description: Intended for labelling the link with a human-readable identifier hreflang: type: string description: Indicates the language of the target resource EndpointTestSelfLink: allOf: - description: A reference to the test. example: href: https://api.thousandeyes.com/v7/endpoint/tests/{type}/281474976710706 - $ref: '#/components/schemas/Link' ScheduledTestResults: type: array description: Reference to the test results. items: $ref: '#/components/schemas/Link' example: - href: https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/network/filter - href: https://api.thousandeyes.com/v7/endpoint/test-results/scheduled-tests/281474976710706/pathvis EndpointTestLinks: type: object description: A list of links that can be accessed to get more information. properties: self: $ref: '#/components/schemas/EndpointTestSelfLink' testResults: $ref: '#/components/schemas/ScheduledTestResults' readOnly: true EndpointAllAgentsSelectorType: type: string example: all-agents pattern: ^all-agents$ EndpointTestMaxMachines: type: integer description: Maximum number of agents which can execute the test. default: 25 example: 25 EndpointAllAgentsSelectorConfig: type: object description: Any agent selection object. readOnly: true properties: agentSelectorType: $ref: '#/components/schemas/EndpointAllAgentsSelectorType' maxMachines: $ref: '#/components/schemas/EndpointTestMaxMachines' required: - agentSelectorType EndpointSpecificAgentsSelectorType: type: string example: specific-agents pattern: ^specific-agents$ EndpointTestAgents: type: array description: List of endpoint agent IDs (obtained from `/endpoint/agents` endpoint). Required when `agentSelectorType` is set to `specific-agent`. items: type: string format: uuid example: - 0a3b9998-dc3a-4ff2-b50d-ac4a7cd986e1 - 66eec0f1-72b4-4755-aa83-3aed61d17f3c EndpointSpecificAgentsSelectorConfig: type: object description: Specific agents selection object. readOnly: true properties: agentSelectorType: $ref: '#/components/schemas/EndpointSpecificAgentsSelectorType' maxMachines: $ref: '#/components/schemas/EndpointTestMaxMachines' agents: $ref: '#/components/schemas/EndpointTestAgents' required: - agentSelectorType EndpointAgentLabelsSelectorType: type: string example: agent-labels pattern: ^agent-labels$ EndpointAgentLabels: type: array deprecated: true description: 'Deprecated. Use `tagIds` instead. List of endpoint agent label IDs (obtained from `/endpoint/labels` endpoint), required when `agentSelectorType` is set to `agent-labels`. ' items: type: string example: - '567' - '214' TagIds: type: array description: List of tag IDs (obtained from `/tags` endpoint). items: type: string format: uuid example: - c6b78e57-81a2-4c5f-a11a-d96c3c664d55 - 5aeab5d5-0d34-4d44-a7ac-fb440185295c EndpointAgentLabelsSelectorConfig: type: object description: Agent labels selection object. readOnly: true deprecated: true properties: agentSelectorType: $ref: '#/components/schemas/EndpointAgentLabelsSelectorType' maxMachines: $ref: '#/components/schemas/EndpointTestMaxMachines' endpointAgentLabels: $ref: '#/components/schemas/EndpointAgentLabels' tagIds: $ref: '#/components/schemas/TagIds' required: - agentSelectorType EndpointAgentTagsSelectorType: type: string example: agent-tags pattern: ^agent-tags$ EndpointAgentTagsSelectorConfig: type: object description: Agent tags selection object. readOnly: true properties: agentSelectorType: $ref: '#/components/schemas/EndpointAgentTagsSelectorType' maxMachines: $ref: '#/components/schemas/EndpointTestMaxMachines' endpointAgentLabels: $ref: '#/components/schemas/EndpointAgentLabels' tagIds: $ref: '#/components/schemas/TagIds' required: - agentSelectorType EndpointAgentSelectorConfig: type: object description: Agents selection object based on agentSelectorType. readOnly: true oneOf: - $ref: '#/components/schemas/EndpointAllAgentsSelectorConfig' - $ref: '#/components/schemas/EndpointSpecificAgentsSelectorConfig' - $ref: '#/components/schemas/EndpointAgentLabelsSelectorConfig' - $ref: '#/components/schemas/EndpointAgentTagsSelectorConfig' discriminator: propertyName: agentSelectorType mapping: all-agents: '#/components/schemas/EndpointAllAgentsSelectorConfig' specific-agents: '#/components/schemas/EndpointSpecificAgentsSelectorConfig' agent-labels: '#/components/schemas/EndpointAgentLabelsSelectorConfig' agent-tags: '#/components/schemas/EndpointAgentTagsSelectorConfig' required: - agentSelectorType TestCreatedDate: type: string format: date-time description: UTC created date (ISO date-time format). example: '2022-07-17T22:00:54Z' readOnly: true TestIsPrioritized: type: boolean description: Indicates whether the test should be prioritized when the number of tests assigned to an agent exceeds the license limit. default: false example: false TestInterval: type: integer enum: - 60 - 120 - 300 - 600 - 900 - 1800 - 3600 description: Interval between test runs in seconds. default: 60 example: 60 TestIsEnabled: type: boolean description: Indicates if test is enabled. example: true default: true TestIsSavedEvent: type: boolean description: '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. ' example: false readOnly: true TestHasPathTraceInSession: type: boolean description: 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 TCP session. example: true TestLabel: type: object properties: labelId: type: string description: Label ID. name: type: string description: Name of the label. isBuiltin: type: boolean description: Value indicating if the label in question is BuiltIn (Account Admin, Organization Admin, Regular User). example: labelId: '961' name: Artem label isBuiltin: false TestLabels: type: array description: Labels to which the test is assigned. This field is not returned for Instant Tests. readOnly: true items: $ref: '#/components/schemas/TestLabel' TestNetworkMeasurements: type: boolean description: Enable or disable network measurements. Set to true to enable or false to disable network measurements. default: true example: true EndpointTestProtocol: type: string enum: - icmp - icmp-with-tcp-connect - tcp - prefer-tcp - ast-autodetect - autodetect description: Protocol requested for the test. default: icmp example: icmp EndpointIpVersionOut: description: For reading current network test configurations, the IP version of the test. Values include V4_ONLY, V6_ONLY, V6_PREFER, and OS_DEFAULT. type: string example: V4_ONLY TestName: type: string description: Name of the test. example: Test name EndpointScheduledTestType: type: string enum: - agent-to-server - http-server description: Type of test being queried. example: agent-to-server readOnly: true TestProbeModeResponse: type: string enum: - auto - sack - syn - syn-pcap - syn-socket - unknown description: Probe mode returned by network test APIs, only valid when the protocol is set to TCP. Configuration responses return user-selectable values, while result responses may also return resolved driver values. default: auto example: auto EndpointTestPort: type: integer description: Port number. default: 443 example: 443 EndpointTest: type: object required: - type properties: aid: $ref: '#/components/schemas/AccountGroupId' _links: $ref: '#/components/schemas/EndpointTestLinks' agentSelectorConfig: $ref: '#/components/schemas/EndpointAgentSelectorConfig' createdDate: $ref: '#/components/schemas/TestCreatedDate' isPrioritized: $ref: '#/components/schemas/TestIsPrioritized' interval: $ref: '#/components/schemas/TestInterval' isEnabled: $ref: '#/components/schemas/TestIsEnabled' isSavedEvent: $ref: '#/components/schemas/TestIsSavedEvent' hasPathTraceInSession: $ref: '#/components/schemas/TestHasPathTraceInSession' labels: $ref: '#/components/schemas/TestLabels' modifiedDate: type: string format: date-time description: UTC last modification date (ISO date-time format). readOnly: true example: '2022-07-17T22:00:54Z' networkMeasurements: $ref: '#/components/schemas/TestNetworkMeasurements' protocol: $ref: '#/components/schemas/EndpointTestProtocol' ipVersion: $ref: '#/components/schemas/EndpointIpVersionOut' server: type: string description: Target domain name or IP address. example: www.example.com testId: type: string description: Each test is assigned a unique ID to access test data from other endpoints. readOnly: true example: '281474976710706' testName: $ref: '#/components/schemas/TestName' type: $ref: '#/components/schemas/EndpointScheduledTestType' tcpProbeMode: $ref: '#/components/schemas/TestProbeModeResponse' port: $ref: '#/components/schemas/EndpointTestPort' EndpointAgentToServerType: type: string description: Type of test being queried. example: agent-to-server pattern: ^agent-to-server$ readOnly: true EndpointAgentToServerTest: allOf: - $ref: '#/components/schemas/EndpointTest' - type: object properties: type: $ref: '#/components/schemas/EndpointAgentToServerType' EndpointTestAuthType: type: string description: HTTP authentication type. enum: - none - basic - ntlm default: none example: none TestUsername: type: string description: Username for Basic/NTLM authentication. example: username TestSslVersionId: type: string description: '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. ' enum: - '0' - '3' - '4' - '5' - '6' - '7' default: '0' example: '0' EndpointTestResultUrl: type: string description: The test target URL. example: https://example.com:443 EndpointHttpServerBaseTest: type: object properties: authType: $ref: '#/components/schemas/EndpointTestAuthType' hasPathTraceInSession: $ref: '#/components/schemas/TestHasPathTraceInSession' httpTimeLimit: type: integer description: Maximum amount of time in milliseconds the agents wait before a request times out. default: 5000 example: 5000 protocol: $ref: '#/components/schemas/EndpointTestProtocol' username: $ref: '#/components/schemas/TestUsername' sslVersionId: $ref: '#/components/schemas/TestSslVersionId' tcpProbeMode: $ref: '#/components/schemas/TestProbeModeResponse' verifyCertificate: type: boolean description: Flag indicating if a certificate should be verified. default: true example: true url: $ref: '#/components/schemas/EndpointTestResultUrl' EndpointHttpServerType: type: string description: Type of test being queried. example: http-server pattern: ^http-server$ readOnly: true TestFollowRedirects: type: boolean description: To disable following HTTP/301 or HTTP/302 redirect directives, set this parameter to `false`. default: true example: true TestHttpTargetTime: type: integer minimum: 100 maximum: 5000 description: Target time for HTTP server completion, specified in milliseconds. example: 100 TestHttpVersion: type: integer minimum: 1 maximum: 2 description: HTTP protocol version. Set to '2' to prefer HTTP/2, or '1' to use only HTTP/1.1. default: 2 example: 2 TestSslVersion: type: string description: Reflects the verbose SSL protocol version used by a test. readOnly: true example: Auto TestUseNtlm: type: boolean description: Set to true to use NTLM, false to use Basic Authentication. Requires username and password to be set. example: false EndpointHttpServerTest: allOf: - $ref: '#/components/schemas/EndpointTest' - $ref: '#/components/schemas/EndpointHttpServerBaseTest' - type: object properties: type: $ref: '#/components/schemas/EndpointHttpServerType' followRedirects: $ref: '#/components/schemas/TestFollowRedirects' httpTargetTime: $ref: '#/components/schemas/TestHttpTargetTime' httpVersion: $ref: '#/components/schemas/TestHttpVersion' isPrioritized: $ref: '#/components/schemas/TestIsPrioritized' interval: $ref: '#/components/schemas/TestInterval' sslVersion: $ref: '#/components/schemas/TestSslVersion' useNtlm: $ref: '#/components/schemas/TestUseNtlm' EndpointScheduledTest: oneOf: - $ref: '#/components/schemas/EndpointAgentToServerTest' - $ref: '#/components/schemas/EndpointHttpServerTest' discriminator: propertyName: type mapping: agent-to-server: '#/components/schemas/EndpointAgentToServerTest' http-server: '#/components/schemas/EndpointHttpServerTest' StartDate: type: string format: date-time example: '2022-07-17T22:00:54Z' description: (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 being retrieved (ISO date-time format). readOnly: true EndDate: type: string format: date-time example: '2022-07-18T22:00:54Z' description: (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 retrieved (ISO date-time format). readOnly: true PaginationNextLink: type: object description: A links object containing a related link for forward pagination. properties: next: $ref: '#/components/schemas/Link' VpnType: type: string description: Name of the VPN provider. enum: - cisco-anyconnect - palo-alto-globalprotect - ivanti-connect-secure - zscaler-internet-access - f5-big-ip example: cisco-anyconnect TestProtocol: type: string enum: - tcp - icmp - udp description: Protocol used by dependent network tests (end-to-end, path trace, PMTUD). default: tcp example: tcp PaginationNextAndSelfLink: type: object description: A links object containing a related link for forward pagination. properties: next: $ref: '#/components/schemas/Link' self: $ref: '#/components/schemas/Link' SelfLinks: type: object description: A links object containing the self link. readOnly: true properties: self: $ref: '#/components/schemas/Link' EndpointTestResultProtocol: type: string enum: - icmp - tcp - udp - prefer-tcp - ast-autodetect - autodetect - unknown description: Protocol used to perform the test. default: unknown example: tcp TcpPathTraceModeResponse: type: string enum: - auto - syn - syn-pcap - unknown - data-in-session-with-decrementing-ttl - data-in-session description: Path trace mode used by network test. Only valid when the protocol is set to TCP. default: auto example: syn-pcap UdpPathTraceModeResponse: type: string enum: - stun-pcap - unknown description: Path trace mode used by network test. Only valid when the protocol is set to UDP. default: unknown example: unknown readOnly: true DynamicTestSelfLink: allOf: - description: The reference to the test. example: href: https://api.thousandeyes.com/v7/dynamic-tests/agent-to-server/281474976710706 - $ref: '#/components/schemas/Link' DynamicTestResults: type: array description: Reference to the test results. items: $ref: '#/components/schemas/Link' example: - href: https://api.thousandeyes.com/v7/endpoint/test-results/dynamic-tests/281474976710706/network/filter - href: https://api.thousandeyes.com/v7/endpoint/test-results/dynamic-tests/281474976710706/pathvis DynamicTestLinks: type: object description: A list of links that can be accessed to get more information. properties: self: $ref: '#/components/schemas/DynamicTestSelfLink' testResults: $ref: '#/components/schemas/DynamicTestResults' readOnly: true DynamicTestApplication: type: string description: Which supported application to monitor, can be one of `webex`, `zoom`, `microsoft-teams`. example: webex TestHasPing: type: boolean description: Optional flag indicating if the test should run ping. default: true TestHasTraceRoute: type: boolean description: Optional flag indicating if the test should run traceroute. default: true DynamicTest: type: object properties: aid: $ref: '#/components/schemas/AccountGroupId' _links: $ref: '#/components/schemas/DynamicTestLinks' agentSelectorConfig: $ref: '#/components/schemas/EndpointAgentSelectorConfig' application: $ref: '#/components/schemas/DynamicTestApplication' createdDate: $ref: '#/components/schemas/TestCreatedDate' isPrioritized: $ref: '#/components/schemas/TestIsPrioritized' interval: $ref: '#/components/schemas/TestInterval' isEnabled: $ref: '#/components/schemas/TestIsEnabled' hasPathTraceInSession: $ref: '#/components/schemas/TestHasPathTraceInSession' hasPing: $ref: '#/components/schemas/TestHasPing' hasTraceroute: $ref: '#/components/schemas/TestHasTraceRoute' modifiedDate: type: string format: date-time description: UTC last modification date (ISO date-time format). readOnly: true example: '2022-07-17T22:00:54Z' networkMeasurements: $ref: '#/components/schemas/TestNetworkMeasurements' protocol: $ref: '#/components/schemas/EndpointTestProtocol' ipVersion: $ref: '#/components/schemas/EndpointIpVersionOut' tcpProbeMode: $ref: '#/components/schemas/TestProbeModeResponse' testId: type: string description: Each test is assigned a unique ID; this is used to access test information and results from other endpoints. readOnly: true example: '281474976710706' testName: $ref: '#/components/schemas/TestName' labels: $ref: '#/components/schemas/TestLabels' UdpProbeModeResponse: type: string enum: - stun-pcap - unknown description: Probe mode used by network test, only valid when the protocol is set to UDP. default: unknown example: unknown readOnly: true InterfaceHardwareType: type: string example: wireless enum: - unknown - wireless - ethernet - modem - virtual - loopback - other UserPrincipalName: type: string description: User login name in Internet-style format, typically used in Active Directory environments. example: joeblogs32@c.com parameters: NetworkTopologyIdPath: name: networkTopologyId description: The network topology ID. required: true in: path schema: type: string example: 00160:39c518560de9:1491651900:236e6f18 IdPath: name: id description: The real user test id. required: true in: path schema: type: string example: 07625:1490529480:h3qJQTpl ExpandEndpointHttpServer: name: expand in: query style: form explode: false description: 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. schema: type: array items: $ref: '#/components/schemas/ExpandEndpointHttpServerOptions' example: - header ExpandEndpointNetwork: name: expand in: query style: form explode: false description: 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 "user-profile," append `?expand=user-profile` to the query. schema: type: array items: $ref: '#/components/schemas/ExpandEndpointNetworkOptions' example: - header ExpandEndpointDynamicNetwork: name: expand in: query style: form explode: false description: 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 "user-profile," append `?expand=user-profile` to the query. schema: type: array items: $ref: '#/components/schemas/ExpandEndpointDynamicNetworkOptions' example: - header ExpandLocalNetworkTopology: name: expand in: query style: form explode: false description: This parameter is optional and determines whether to expand resources related to local network topologies. By default, no expansion occurs when this query parameter is omitted. To expand a specific resource, such as `systemMetricDetails`, append `?expand=system-metric-detail` to the query. schema: type: array items: $ref: '#/components/schemas/ExpandLocalNetworkTopologyOptions' example: - system-metric-detail TestIdPath: name: testId description: Test ID required: true in: path schema: type: string example: '202701' AccountGroupId: name: aid in: query description: 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. required: false schema: type: string example: '1234' Window: name: window in: query description: '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`.' schema: type: string pattern: ^\d+(?:[smhdw]{1})?$ example: 12h StartDateParameter: name: startDate in: query description: 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`. schema: type: string format: date-time example: '2022-07-17T22:00:54Z' EndDateParameter: name: endDate in: query description: 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`. schema: type: string format: date-time example: '2022-07-18T22:00:54Z' PaginationCursor: name: cursor in: query example: null description: (Optional) Opaque cursor used for pagination. Clients should use `next` value from `_links` instead of this parameter. schema: type: string example: null PaginationMax: name: max in: query description: (Optional) Maximum number of objects to return. schema: type: integer example: 5 UseAllPermittedAids: name: useAllPermittedAids in: query required: false description: Set to `true` to load data from all accounts the user has access to. schema: type: boolean example: false default: false AgentIdPath: name: agentId description: Agent ID required: true in: path schema: type: string example: '11' RoundIdPath: name: roundId description: Round ID required: true in: path schema: type: string example: '1384309800' PageIdPath: name: pageId description: Web page ID required: true in: path schema: type: string example: '281474976710706' responses: '400': description: Bad Request content: application/problem+json: schema: $ref: '#/components/schemas/ValidationError' example: type: about:blank title: Request validation failed. There are invalid or missing fields status: 400 detail: Your request object contains invalid fields. instance: /v7 errors: - code: AM-5432 field: firstName message: firstName cannot have fancy characters - code: DASH-5622 field: password message: Password cannot be blank '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedError' '403': description: Insufficient permissions to query endpoint content: application/problem+json: schema: $ref: '#/components/schemas/Error' '404': description: Not found content: application/problem+json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: URI Resource Not Found status: 404 detail: Details explaining if the 404 error is related to an invalid URI or a wrong ID instance: /v7 '429': description: Exhausted rate limit for the organization content: application/problem+json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error content: application/problem+json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: Internal server error status: 500 detail: Optional detail about the internal error message. instance: /v7 '502': description: Bad Gateway content: application/problem+json: schema: $ref: '#/components/schemas/Error'