# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for ThousandEyes Dashboard Snapshots API
  version: 1.0.0
extends: openapi/thousandeyes-dashboard-snapshots-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: 6
- target: $.paths['/dashboard-snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboard snapshots
      effect: read
      questions:
      - What dashboard snapshots exist in my account group?
      - Can I list only the snapshots taken from one dashboard?
      instructions:
      - text: List all dashboard snapshots.
      - text: Show snapshots of dashboard {dashboardId}.
        slots:
          dashboardId: query.dashboardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard-snapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dashboard snapshot
      effect: write
      questions:
      - How do I freeze a dashboard for a time range to share it?
      - Can a dashboard snapshot anonymize data and set an expiration date?
      instructions:
      - text: Snapshot dashboard {dashboardId} from {startDate} to {endDate}.
        slots:
          dashboardId: requestBody.dashboardId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Create an anonymized snapshot of dashboard {dashboardId} named {displayName}.
        slots:
          dashboardId: requestBody.dashboardId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard-snapshots/{snapshotId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard snapshot's widgets
      effect: read
      questions:
      - Which widgets does a dashboard snapshot contain?
      - What is configured inside a saved dashboard snapshot?
      instructions:
      - text: Show dashboard snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      - text: List the widgets in snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard-snapshots/{snapshotId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard snapshot
      effect: destructive
      questions:
      - Can I delete a dashboard snapshot I shared?
      - Can an account admin remove someone else's dashboard snapshot?
      instructions:
      - text: Delete dashboard snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      - text: Remove snapshot {snapshotId} from account group {aid}.
        slots:
          snapshotId: path.snapshotId
          aid: query.aid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard-snapshots/{snapshotId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a dashboard snapshot's expiry
      effect: write
      questions:
      - How do I extend when a dashboard snapshot expires?
      - Can I change the expiration date of an existing snapshot?
      instructions:
      - text: Set dashboard snapshot {snapshotId} to expire on {expirationDate}.
        slots:
          snapshotId: path.snapshotId
          expirationDate: requestBody.expirationDate
      - text: Extend the expiry of snapshot {snapshotId}.
        slots:
          snapshotId: path.snapshotId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboard-snapshots/{snapshotId}/widgets/{widgetId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get data behind a snapshot widget
      effect: read
      questions:
      - How do I pull the raw metrics behind one widget in a dashboard snapshot?
      - Can I get the data a snapshot widget was generated from?
      instructions:
      - text: Get the data for widget {widgetId} in snapshot {snapshotId}.
        slots:
          widgetId: path.widgetId
          snapshotId: path.snapshotId
      - text: Show the metrics behind widget {widgetId} of dashboard snapshot {snapshotId}.
        slots:
          widgetId: path.widgetId
          snapshotId: path.snapshotId
      method: generated
      generated: '2026-09-26'