Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Competitor AI API

3 actions 3 updates phrasing extends openapi/birdeye-competitor-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 3

$.info
$.paths['/v1/competitors/review'].post
$.paths['/v1/competitors/review/metrics'].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 Competitor AI API
  version: 1.0.0
extends: openapi/birdeye-competitor-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: 2
- target: $.paths['/v1/competitors/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve competitors' reviews
      effect: read
      questions:
      - Can I pull the actual reviews my competitors received over a date range?
      - Can I filter competitor reviews by brand, source, or competitor location?
      instructions:
      - text: Retrieve competitor reviews for locations {businessNumbers} from {fromDate} to {toDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
      - text: Get the review text left for competitor brands {brandIds}.
        slots:
          brandIds: requestBody.brandIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/competitors/review/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Get competitor review metrics
      effect: read
      questions:
      - What are my competitors' review counts and average ratings?
      - Can I get aggregated review metrics per competitor location instead of the review text?
      instructions:
      - text: Get competitor review metrics for {businessNumbers} between {fromDate} and {toDate}.
        slots:
          businessNumbers: requestBody.businessNumbers
          fromDate: requestBody.fromDate
          toDate: requestBody.toDate
      - text: Show review metrics for competitor locations {competitorLocationIds}.
        slots:
          competitorLocationIds: requestBody.competitorLocationIds
      method: generated
      generated: '2026-09-26'