ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Network Endpoint Scheduled Test Results API

5 actions 5 updates phrasing extends openapi/thousandeyes-network-endpoint-scheduled-test-results-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ThousandEyes's API. It is a proposal applied on top of the contract, not a document ThousandEyes publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/endpoint/test-results/scheduled-tests/{testId}/network/filter'].post
$.paths['/endpoint/test-results/scheduled-tests/network/filter'].post
$.paths['/endpoint/test-results/scheduled-tests/{testId}/path-vis'].get
$.paths['/endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Network Endpoint Scheduled Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-network-endpoint-scheduled-test-results-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/endpoint/test-results/scheduled-tests/{testId}/network/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Get network results for one scheduled test
      effect: read
      questions:
      - What loss, latency and jitter did endpoint agents see for a scheduled test?
      - Can I filter one scheduled test's network results by time window?
      instructions:
      - text: Get endpoint network results for scheduled test {testId}.
        slots:
          testId: path.testId
      - text: Show loss and latency for scheduled test {testId} over the last {window}.
        slots:
          testId: path.testId
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/scheduled-tests/network/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Get network results across scheduled tests
      effect: read
      questions:
      - Can I pull endpoint network metrics for several scheduled tests at once?
      - Is it possible to query scheduled test results across all permitted account groups?
      instructions:
      - text: Get network results for scheduled tests matching {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      - text: Fetch loss, latency and jitter across scheduled tests from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/scheduled-tests/{testId}/path-vis'].get
  update:
    x-apievangelist-phrasing:
      intent: Get path visualization for a scheduled test
      effect: read
      questions:
      - What network path did endpoint agents take for a scheduled test?
      - Can I see a path visualization summary for a scheduled endpoint test?
      instructions:
      - text: Show path visualization for scheduled test {testId}.
        slots:
          testId: path.testId
      - text: Get scheduled test {testId} path results for the last {window}.
        slots:
          testId: path.testId
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/scheduled-tests/{testId}/path-vis/agent/{agentId}/round/{roundId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get hop-by-hop path for a scheduled test round
      effect: read
      questions:
      - Can I see every hop for one endpoint agent in one round of a scheduled test?
      - Where do I get the detailed path trace for a scheduled test round?
      instructions:
      - text: Show hops for scheduled test {testId}, agent {agentId}, round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Get the path trace detail of scheduled test {testId} from agent {agentId} in round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      method: generated
      generated: '2026-09-26'