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.
# 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 Test Results API
version: 1.0.0
extends: openapi/thousandeyes-network-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['/test-results/{testId}/network'].get
update:
x-apievangelist-phrasing:
intent: Get network test results
effect: read
questions:
- What latency, loss and jitter did my test record in the latest round?
- Can I get network metrics for a test over a custom time range?
instructions:
- text: Get network results for test {testId}.
slots:
testId: path.testId
- text: Show network metrics for test {testId} from {startDate} to {endDate}.
slots:
testId: path.testId
startDate: query.startDate
endDate: query.endDate
method: generated
generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/path-vis'].get
update:
x-apievangelist-phrasing:
intent: Get path visualization results
effect: read
questions:
- How do I see the hop-by-hop path my test traffic took?
- Can I get path trace summaries for a time window?
instructions:
- text: Get path visualization results for test {testId}.
slots:
testId: path.testId
- text: Show path traces for test {testId} over the last {window}.
slots:
testId: path.testId
window: query.window
method: generated
generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/path-vis/agent/{agentId}/round/{roundId}'].get
update:
x-apievangelist-phrasing:
intent: Get path trace for one agent round
effect: read
questions:
- Which route did a single agent take in one round of my test?
- Can I view the path trace for one agent in a specific direction?
instructions:
- text: Get the path trace for test {testId} from agent {agentId} in round {roundId}.
slots:
testId: path.testId
agentId: path.agentId
roundId: path.roundId
- text: Show the {direction} path of agent {agentId}, round {roundId}, test {testId}.
slots:
direction: query.direction
agentId: path.agentId
roundId: path.roundId
testId: path.testId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.