ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Web Transactions Test Results API

5 actions 5 updates phrasing extends openapi/thousandeyes-web-transactions-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['/test-results/{testId}/web-transactions'].get
$.paths['/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}'].get
$.paths['/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId}'].get
$.paths['/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/console-logs'].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 Web Transactions Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-web-transactions-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['/test-results/{testId}/web-transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get web transaction test results
      effect: read
      questions:
      - How did my scripted web transaction perform in the latest round?
      - Can I pull web transaction results for a specific time window?
      instructions:
      - text: Get web transaction results for test {testId}.
        slots:
          testId: path.testId
      - text: Show web transaction results for test {testId} over the last {window}.
        slots:
          testId: path.testId
          window: query.window
      - text: Get web transaction results 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}/web-transactions/agent/{agentId}/round/{roundId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get web transaction results for an agent round
      effect: read
      questions:
      - Which call shows what one agent saw in one transaction round?
      - Can I drill into a single agent's run of a web transaction test?
      instructions:
      - text: Get web transaction results for test {testId} from agent {agentId} in round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Show round {roundId} of transaction test {testId} as seen by agent {agentId}.
        slots:
          roundId: path.roundId
          testId: path.testId
          agentId: path.agentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/page/{pageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one page of a web transaction run
      effect: read
      questions:
      - How do I see timings for one page inside a web transaction?
      - What detail is available for a single page in an agent's transaction round?
      instructions:
      - text: Get page {pageId} of web transaction test {testId} for agent {agentId}, round {roundId}.
        slots:
          pageId: path.pageId
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Show the detailed page {pageId} result from agent {agentId} round {roundId} of test {testId}.
        slots:
          pageId: path.pageId
          agentId: path.agentId
          roundId: path.roundId
          testId: path.testId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/test-results/{testId}/web-transactions/agent/{agentId}/round/{roundId}/console-logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get browser console logs from a transaction run
      effect: read
      questions:
      - Can I see browser console errors from a web transaction test?
      - Where do I find the console logs an agent captured during a transaction round?
      instructions:
      - text: Get console logs for test {testId} from agent {agentId} in round {roundId}.
        slots:
          testId: path.testId
          agentId: path.agentId
          roundId: path.roundId
      - text: Show browser console output of agent {agentId}, round {roundId}, test {testId}.
        slots:
          agentId: path.agentId
          roundId: path.roundId
          testId: path.testId
      method: generated
      generated: '2026-09-26'