# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for V Analytics API
  version: 1.0.0
extends: openapi/vendasta-vanalytics-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: 5
- target: $.paths['/v1/business-metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Push business metric data points
      effect: write
      questions:
      - How do I send my own metric values into business reports?
      - Can I submit decimal or text values as business metric points?
      instructions:
      - text: Push points {points} for metric {label} on business {business}.
        slots:
          points: requestBody.points
          label: requestBody.label
          business: requestBody.businessId
      - text: 'Record metric {label} data for {business}: {points}.'
        slots:
          label: requestBody.label
          business: requestBody.businessId
          points: requestBody.points
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-metrics/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a business metric point
      effect: destructive
      questions:
      - Can I delete one metric data point I pushed by mistake?
      - Is a deleted metric point permanently removed?
      instructions:
      - text: Delete business metric point {id}.
        slots:
          id: requestBody.id
      - text: Mark metric point {id} as deleted.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-metrics/delete-multi'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete several business metric points
      effect: destructive
      questions:
      - Can I delete many metric points in one call?
      - What happens when some points in a batch delete are already gone?
      instructions:
      - text: 'Delete these business metric points: {metrics}.'
        slots:
          metrics: requestBody.businessMetrics
      - text: Bulk remove metric points {metrics} and report failures.
        slots:
          metrics: requestBody.businessMetrics
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-metrics/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a business metric over a date range
      effect: read
      questions:
      - What values were recorded for a metric over a date range?
      - Can I page through a business metric's data points?
      instructions:
      - text: Get metric {label} for business {business} over {range}.
        slots:
          label: requestBody.label
          business: requestBody.businessId
          range: requestBody.dateRange
      - text: Show {size} points per page of {label} for {business} in {range}.
        slots:
          size: requestBody.pageSize
          label: requestBody.label
          business: requestBody.businessId
          range: requestBody.dateRange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/business-metrics/point/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one business metric point
      effect: read
      questions:
      - Can I see the full details of a single metric data point?
      - How do I check whether a specific metric point was deleted?
      instructions:
      - text: Get business metric point {id}.
        slots:
          id: requestBody.id
      - text: Show source, value and deletion status of metric point {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'