Tricentis · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for NeoLoad Results|Elements API

9 actions 9 updates phrasing extends openapi/tricentis-results-elements-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Tricentis's API. It is a proposal applied on top of the contract, not a document Tricentis publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/values'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/values'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/points'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/percentiles'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/raw'].get
$.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/sla'].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 NeoLoad Results|Elements API
  version: 1.0.0
extends: openapi/tricentis-results-elements-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List elements of a test result by category
      effect: read
      questions:
      - Which transactions or requests were measured in a load test result?
      - Do I have to pick an element category when listing result elements?
      instructions:
      - text: List the {category} elements of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          category: query.category
      - text: Show the transactions measured in test result {result}.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get values for every element of a test result
      effect: read
      questions:
      - Can I get aggregated values for all elements of a test result in one call?
      - What were the average response times across all transactions in a run?
      instructions:
      - text: Get values for all {category} elements of test result {result} in workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          category: query.category
      - text: Show aggregated values for every element in test result {result}.
        slots:
          result: path.resultId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one test result element definition
      effect: read
      questions:
      - How do I see the definition of a single element in a test result?
      - What type and path does this result element have?
      instructions:
      - text: Get the definition of element {element} in test result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
      - text: Describe result element {element} of test result {result}.
        slots:
          result: path.resultId
          element: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: Get values of one test result element
      effect: read
      questions:
      - What were the aggregated values for one transaction in a test result?
      - Can I get min, max and average for a single element?
      instructions:
      - text: Get the values of element {element} in test result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
      - text: Show aggregated stats for transaction {element} in result {result}.
        slots:
          result: path.resultId
          element: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/points'].get
  update:
    x-apievangelist-phrasing:
      intent: Get time-series points for a result element
      effect: read
      questions:
      - How do I chart a transaction's response time over the duration of a test?
      - Which statistics can I request as points for an element?
      instructions:
      - text: Get {statistics} points over time for element {element} in test result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
          statistics: query.statistics
      - text: Plot the time series for element {element} of result {result}.
        slots:
          result: path.resultId
          element: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/percentiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Get response-time percentiles for a transaction
      effect: read
      questions:
      - What was the 95th percentile response time for a transaction?
      - Can I get percentile distribution for one element of a test result?
      instructions:
      - text: Get percentiles for transaction {element} in test result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
      - text: Show the response-time percentile curve for element {element} in result {result}.
        slots:
          result: path.resultId
          element: path.elementId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/raw'].get
  update:
    x-apievangelist-phrasing:
      intent: Download raw data for one transaction
      effect: read
      questions:
      - Can I export the raw samples for a single transaction as CSV?
      - How long is raw transaction data kept before it's deleted?
      instructions:
      - text: Download raw data for transaction {element} in test result {result}, workspace {ws}, as {format}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
          format: query.format
      - text: Export transaction {element} raw samples from result {result} in {format}.
        slots:
          result: path.resultId
          element: path.elementId
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/workspaces/{workspaceId}/test-results/{resultId}/elements/{elementId}/sla'].get
  update:
    x-apievangelist-phrasing:
      intent: Get SLA status of one result element
      effect: read
      questions:
      - Did a specific transaction meet its SLA during the test?
      - How do I check the SLA status for one element of a test result?
      instructions:
      - text: Get the SLA status of element {element} in test result {result}, workspace {ws}.
        slots:
          ws: path.workspaceId
          result: path.resultId
          element: path.elementId
      - text: Check whether transaction {element} in result {result} breached its SLA.
        slots:
          result: path.resultId
          element: path.elementId
      method: generated
      generated: '2026-10-01'