ThousandEyes · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThousandEyes Usage API

4 actions 4 updates phrasing extends openapi/thousandeyes-usage-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['/usage'].get

$.paths['/usage/units/enterprise-agents'].get

$.paths['/usage/units/tests'].get

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 Usage API
  version: 1.0.0
extends: openapi/thousandeyes-usage-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['/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage for the current period
      effect: read
      questions:
      - How many units has my organization used this billing period?
      - What permission do I need to view usage across account groups?
      instructions:
      - text: Show my organization's usage for the current period.
      - text: Get usage for account group {aid}.
        slots:
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usage/units/enterprise-agents'].get
  update:
    x-apievangelist-phrasing:
      intent: Get enterprise agent unit usage
      effect: read
      questions:
      - How many units are my enterprise agents consuming?
      - Can I see enterprise agent usage for a specific date range?
      instructions:
      - text: Show enterprise agent usage for the current billing cycle.
      - text: Get enterprise agent units used from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/usage/units/tests'].get
  update:
    x-apievangelist-phrasing:
      intent: Get unit usage by test
      effect: read
      questions:
      - Which tests are consuming the most cloud and enterprise agent units?
      - Is per-test unit usage available for a past period?
      instructions:
      - text: Show unit usage for every test this billing cycle.
      - text: Get per-test cloud and enterprise agent usage from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-09-26'