Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Insight AI API

4 actions 4 updates phrasing extends openapi/birdeye-insight-ai-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Birdeye's API. It is a proposal applied on top of the contract, not a document Birdeye publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v1/insight/experience/scoreBenchmark'].post
$.paths['/v1/insight/experience/locationInfo'].post
$.paths['/v1/insight/experience/over-time'].post

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 Birdeye Insight AI API
  version: 1.0.0
extends: openapi/birdeye-insight-ai-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: 3
- target: $.paths['/v1/insight/experience/scoreBenchmark'].post
  update:
    x-apievangelist-phrasing:
      intent: Benchmark experience scores
      effect: read
      questions:
      - What is my experience score benchmark for a set of locations?
      - Can I benchmark experience scores filtered by review source and rating?
      instructions:
      - text: Get the experience score benchmark for {businessNumbers} from {startDate} to {endDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Benchmark experience scores for {businessNumbers} between {startDate} and {endDate} using sources {reviewSources}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          reviewSources: requestBody.reviewSources
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/insight/experience/locationInfo'].post
  update:
    x-apievangelist-phrasing:
      intent: Get experience insights per location
      effect: read
      questions:
      - Can I see experience insights broken down per location?
      - Which locations score best on experience in a date range?
      instructions:
      - text: Get experience location info for {businessNumbers} from {startDate} to {endDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      - text: Show per-location experience insights for {businessNumbers} between {startDate} and {endDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/insight/experience/over-time'].post
  update:
    x-apievangelist-phrasing:
      intent: Trend experience scores over time
      effect: read
      questions:
      - How has my experience score trended week over week?
      - Can I group experience scores by month or quarter?
      instructions:
      - text: Get experience scores over time for {businessNumbers} from {startDate} to {endDate} grouped by {groupBy}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          groupBy: requestBody.groupBy
      - text: Trend sentiment, reputation, listing and call scores for {businessNumbers} between {startDate} and {endDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'