ThousandEyes · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/thousandeyes-network-dynamic-endpoint-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 4

$.info
$.paths['/endpoint/test-results/dynamic-tests/{testId}/network/filter'].post
$.paths['/endpoint/test-results/dynamic-tests/{testId}/path-vis'].get
$.paths['/endpoint/test-results/dynamic-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 Dynamic Endpoint Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-network-dynamic-endpoint-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: 3
- target: $.paths['/endpoint/test-results/dynamic-tests/{testId}/network/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Get network results for a dynamic test
      effect: read
      questions:
      - What loss, latency, jitter and bandwidth did endpoint agents see on a dynamic test?
      - Can I filter dynamic test results by a time range?
      instructions:
      - text: Get network results for dynamic test {testId}.
        slots:
          testId: path.testId
      - text: Show dynamic test {testId} metrics from {startDate} to {endDate}.
        slots:
          testId: path.testId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/dynamic-tests/{testId}/path-vis'].get
  update:
    x-apievangelist-phrasing:
      intent: Get path visualization for a dynamic test
      effect: read
      questions:
      - What route did endpoint agents take to the destination of a dynamic test?
      - Can I see a path visualization summary for a dynamic endpoint test?
      instructions:
      - text: Show path visualization for dynamic test {testId}.
        slots:
          testId: path.testId
      - text: Get dynamic 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/dynamic-tests/{testId}/path-vis/agent/{agentId}/round/{roundId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get hop-by-hop path for a dynamic test round
      effect: read
      questions:
      - Can I see each hop one endpoint agent crossed in a round of a dynamic test?
      - Where is the detailed dynamic test path trace for a single round?
      instructions:
      - text: Show hops for dynamic test {testId}, agent {agentId}, round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Get the path trace detail of dynamic test {testId} from agent {agentId} in round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      method: generated
      generated: '2026-09-26'