# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Report API
  version: 1.0.0
extends: openapi/birdeye-report-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: 17
- target: $.paths['/v1/reports/smb'].get
  update:
    x-apievangelist-phrasing:
      intent: Get small-business dashboard data
      effect: read
      questions:
      - Can I get the summary dashboard numbers for a small business?
      - What does the SMB dashboard report include?
      instructions:
      - text: Get dashboard data for business {bid}.
        slots:
          bid: query.bid
      - text: Show the SMB dashboard for {bid}.
        slots:
          bid: query.bid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/business/analytics/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the review request conversion report
      effect: read
      questions:
      - What is my review request conversion rate for recent days or months?
      - Can I get the email review conversion report for a date range?
      instructions:
      - text: Get the review conversion report for {businessId} from {fromDate} to {toDate}.
        slots:
          businessId: query.businessId
          fromDate: query.fromDate
          toDate: query.toDate
      - text: Show review conversion for {businessId} over the last {days} days.
        slots:
          businessId: query.businessId
          days: query.days
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/review/analytic/time'].post
  update:
    x-apievangelist-phrasing:
      intent: Trend review count and rating over time
      effect: read
      questions:
      - How have my review count and average rating changed over time?
      - Can I trend ratings by review source over the past days?
      instructions:
      - text: Get the review and rating over time report for {businessId}.
        slots:
          businessId: query.businessId
      - text: Trend reviews and ratings for {businessId} over the last {days} days by sources {sourceAliases}.
        slots:
          businessId: query.businessId
          days: requestBody.days
          sourceAliases: requestBody.sourceAliases
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/rating/location'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare reviews and rating by location
      effect: read
      questions:
      - Which locations have the most reviews and highest ratings?
      - Can I rank locations by rating over the last few months?
      instructions:
      - text: Get reviews and rating by location for {businessId}.
        slots:
          businessId: query.businessId
      - text: Rank locations of {businessId} by {sortby} over the last {months} months.
        slots:
          businessId: query.businessId
          sortby: query.sortby
          months: requestBody.months
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/count-by-rating/{BusinessId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Count reviews by star rating
      effect: read
      questions:
      - How many reviews did I get at each star rating?
      - Can I get review counts by rating for a specific source?
      instructions:
      - text: Get review count by rating for {BusinessId} from {fromDate} to {toDate}.
        slots:
          BusinessId: path.BusinessId
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
      - text: Break down {BusinessId} reviews by star rating for source {sourceAlias}.
        slots:
          BusinessId: path.BusinessId
          sourceAlias: requestBody.sourceAlias
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/count-by-rating/employee/{BusinessId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Count reviews and ratings by employee
      effect: read
      questions:
      - How many reviews and what ratings does each employee have?
      - Can I filter the employee review report to certain staff?
      instructions:
      - text: Get review count and rating by employee for {BusinessId}.
        slots:
          BusinessId: path.BusinessId
      - text: Show employee review ratings for {employees} at {BusinessId}.
        slots:
          employees: requestBody.employees
          BusinessId: path.BusinessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/keywords/opmetric/location'].post
  update:
    x-apievangelist-phrasing:
      intent: Get review insight categories by location
      effect: read
      questions:
      - How do my locations compare on insight categories from review content?
      - Can I get category insights per location for certain review sites?
      instructions:
      - text: Get the insights category report by location for {businessId}.
        slots:
          businessId: query.businessId
      - text: Show category insights per location for {businessNumbers} under {businessId} from {startDate} to {endDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          businessId: query.businessId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/competitive/ranking'].post
  update:
    x-apievangelist-phrasing:
      intent: Get the competitive ranking report
      effect: read
      questions:
      - Where do I rank against competitors on reviews?
      - Can I limit the competitive ranking to specific review sites?
      instructions:
      - text: Get the competitive ranking report for {businessId}.
        slots:
          businessId: query.businessId
      - text: Show competitive ranking for {businessId} from {startDate} to {endDate} on {reviewSites}.
        slots:
          businessId: query.businessId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          reviewSites: requestBody.reviewSites
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/nps/time/elst'].post
  update:
    x-apievangelist-phrasing:
      intent: Trend Net Promoter Score over time
      effect: read
      questions:
      - How has my Net Promoter Score changed over time?
      - Can I see NPS movement for a custom date range?
      instructions:
      - text: Get NPS over time for {businessId}.
        slots:
          businessId: query.businessId
      - text: Trend NPS for {businessId} between {startDate} and {endDate}.
        slots:
          businessId: query.businessId
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/nps/location/elst'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare Net Promoter Score by location
      effect: read
      questions:
      - Which locations have the highest NPS?
      - Can I compare NPS across specific locations?
      instructions:
      - text: Get NPS by location for {businessId}.
        slots:
          businessId: query.businessId
      - text: Compare NPS for locations {businessNumbers} under {businessId}.
        slots:
          businessNumbers: requestBody.businessNumbers
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/count/reviewsite'].post
  update:
    x-apievangelist-phrasing:
      intent: Count reviews by review site
      effect: read
      questions:
      - Which review sites bring in the most reviews?
      - Can I count reviews per source over recent months?
      instructions:
      - text: Get the review by source report for {businessId}.
        slots:
          businessId: query.businessId
      - text: Count reviews per site for {businessId} over the last {months} months.
        slots:
          businessId: query.businessId
          months: requestBody.months
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/count/visitors'].post
  update:
    x-apievangelist-phrasing:
      intent: Get visitor counts
      effect: read
      questions:
      - How many visitors did my locations get by source?
      - Can I get visitor counts for the past few months?
      instructions:
      - text: Get the visitor report for {businessId}.
        slots:
          businessId: query.businessId
      - text: Show visitor counts for {businessId} over the last {months} months.
        slots:
          businessId: query.businessId
          months: requestBody.months
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/usage'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a usage report
      effect: read
      questions:
      - Can I get a usage report as a summary or a table?
      - What usage data is available for a business over a period?
      instructions:
      - text: Get the {reportType} usage report for {business_id} starting at {sindex}, count {count}.
        slots:
          reportType: query.reportType
          business_id: query.business_id
          sindex: query.sindex
          count: query.count
      - text: Pull usage for {business_id} from {startDate} to {endDate}, {reportType} view, index {sindex}, count {count}.
        slots:
          business_id: query.business_id
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          reportType: query.reportType
          sindex: query.sindex
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/response-rate/time/rate-over-time'].post
  update:
    x-apievangelist-phrasing:
      intent: Trend review response rate over time
      effect: read
      questions:
      - How has my review response rate trended?
      - Can I compare response rate over time with a previous period?
      instructions:
      - text: Get review response rate over time for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Trend response rate from {startDate} to {endDate} compared by {comparisonFilter}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          comparisonFilter: requestBody.comparisonFilter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/response-rate/by-location/overview'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare review response rate by location
      effect: read
      questions:
      - Which locations respond to the most reviews?
      - Can I sort locations by review response rate?
      instructions:
      - text: Get the response rate by location overview for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Rank locations by response rate from {startDate} to {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/avg-response-time/by-location'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare average review response time by location
      effect: read
      questions:
      - Which locations take the longest to reply to reviews?
      - Can I sort locations by average response time?
      instructions:
      - text: Get average review response time by location sorted by {sortBy}.
        slots:
          sortBy: query.sortBy
      - text: Show response time per location for {businessNumbers}, sorted by {sortBy}.
        slots:
          businessNumbers: requestBody.businessNumbers
          sortBy: query.sortBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/review/report/avg-response-time/time'].post
  update:
    x-apievangelist-phrasing:
      intent: Trend average review response time
      effect: read
      questions:
      - Is our average review response time getting faster over time?
      - Can I trend response time for low-star reviews only?
      instructions:
      - text: Get average response time over time for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Trend review reply time from {startDate} to {endDate} for ratings {ratings}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          ratings: requestBody.ratings
      method: generated
      generated: '2026-09-26'