ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Real User Endpoint Test Results API

6 actions 6 updates phrasing extends openapi/thousandeyes-real-user-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 6

$.info

$.paths['/endpoint/test-results/real-user-tests/filter'].post

$.paths['/endpoint/test-results/real-user-tests/{id}'].get

$.paths['/endpoint/test-results/real-user-tests/pages/filter'].post

$.paths['/endpoint/test-results/real-user-tests/{id}/pages/{pageId}'].get

$.paths['/endpoint/test-results/real-user-tests/networks/filter'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Real User Endpoint Test Results API
  version: 1.0.0
extends: openapi/thousandeyes-real-user-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: 5
- target: $.paths['/endpoint/test-results/real-user-tests/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search endpoint real user test results
      effect: read
      questions:
      - How do I see what real users experienced over the last day?
      - Can I filter real user test results by a time window?
      instructions:
      - text: List real user test results for the last {window}.
        slots:
          window: query.window
      - text: Find real user test results between {startDate} and {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      - text: Search real user tests using filters {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/real-user-tests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one endpoint real user test
      effect: read
      questions:
      - What detail is recorded for a single real user test?
      - Can I retrieve one real user session by its ID?
      instructions:
      - text: Show real user test {id}.
        slots:
          id: path.id
      - text: Get the detailed results of endpoint real user test {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/real-user-tests/pages/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search pages visited in real user tests
      effect: read
      questions:
      - Which web pages did my users visit during real user tests?
      - Can I filter visited pages by domain, Wi-Fi SSID or VPN?
      instructions:
      - text: List pages visited on domain {domain} in real user tests.
        slots:
          domain: requestBody.domain
      - text: Show real user visited pages for agent {agentId} over the last {window}.
        slots:
          agentId: requestBody.agentId
          window: query.window
      - text: Find visited pages from users on SSID {ssid}.
        slots:
          ssid: requestBody.ssid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/real-user-tests/{id}/pages/{pageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a real user page's waterfall
      effect: read
      questions:
      - How do I see the full request waterfall for one page a user loaded?
      - Does a real user page result include every object request?
      instructions:
      - text: Show page {pageId} of real user test {id}.
        slots:
          pageId: path.pageId
          id: path.id
      - text: Get the waterfall for page {pageId} in real user test {id}.
        slots:
          pageId: path.pageId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpoint/test-results/real-user-tests/networks/filter'].post
  update:
    x-apievangelist-phrasing:
      intent: Search networks seen in real user tests
      effect: read
      questions:
      - What networks were my users on during real user tests?
      - Is it possible to filter real user network data by date range?
      instructions:
      - text: List the networks used in real user tests over the last {window}.
        slots:
          window: query.window
      - text: Search real user test networks with filters {searchFilters}.
        slots:
          searchFilters: requestBody.searchFilters
      method: generated
      generated: '2026-09-26'