Automation Anywhere · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Automation Anywhere Bot Insight Task Data API

4 actions 4 updates phrasing extends openapi/automation-anywhere-task-data-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Automation Anywhere's API. It is a proposal applied on top of the contract, not a document Automation Anywhere publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/gettaskmetadata/{taskName}'].get

$.paths['/gettaskvariableprofile/{taskName}'].get

$.paths['/gettasklogdata/{taskName}/{startIndex}/{startDate}'].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 Automation Anywhere Bot Insight Task Data API
  version: 1.0.0
extends: openapi/automation-anywhere-task-data-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: 3
- target: $.paths['/gettaskmetadata/{taskName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a bot task's analytics metadata
      effect: read
      questions:
      - Which KPI variables and dimensions are configured for a bot task in Bot Insight?
      - What data types do a task's analytics variables use?
      instructions:
      - text: Get the analytics metadata for task {taskName}.
        slots:
          taskName: path.taskName
      - text: Show the KPI variables configured for bot task {taskName}.
        slots:
          taskName: path.taskName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gettaskvariableprofile/{taskName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated KPI values for a bot task
      effect: read
      questions:
      - What were the aggregated KPI values for a bot task over a date range?
      - How long a date range can I request for a task's variable profile?
      instructions:
      - text: Get the variable profile for task {taskName} from {from} to {to}.
        slots:
          taskName: path.taskName
          from: query.from
          to: query.to
      - text: Summarize the KPI totals for bot task {taskName}.
        slots:
          taskName: path.taskName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gettasklogdata/{taskName}/{startIndex}/{startDate}'].get
  update:
    x-apievangelist-phrasing:
      intent: Export per-run log data for a bot task
      effect: read
      questions:
      - Can I extract raw per-run KPI values for a bot task into my data warehouse?
      - How do I page through a task's execution log records?
      instructions:
      - text: Get task {taskName}'s log data since {startDate} starting at record {startIndex}.
        slots:
          taskName: path.taskName
          startDate: path.startDate
          startIndex: path.startIndex
      - text: Pull raw per-run values for task {taskName} from {startDate}, first page ({startIndex}).
        slots:
          taskName: path.taskName
          startDate: path.startDate
          startIndex: path.startIndex
      method: generated
      generated: '2026-10-01'