Birdeye · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Birdeye Aggregation API

5 actions 5 updates phrasing extends openapi/birdeye-aggregation-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 5

$.info

$.paths['/v1/aggregation/business/{businessId}'].get

$.paths['/v1/survey/reviewsites-alias'].get

$.paths['/v1/aggregation/business/{business_id}'].post

$.paths['/v1/aggregation/business/{businessID}/aggregation/{aggregationID}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Aggregation API
  version: 1.0.0
extends: openapi/birdeye-aggregation-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: 4
- target: $.paths['/v1/aggregation/business/{businessId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a business's review aggregation sources
      effect: read
      questions:
      - Which review site URLs is Birdeye aggregating reviews from for my location?
      - Can I see every aggregation source configured on one business?
      instructions:
      - text: List the aggregation sources set up for business {businessId}.
        slots:
          businessId: path.businessId
      - text: Show which review site pages are being crawled for business {businessId}.
        slots:
          businessId: path.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/survey/reviewsites-alias'].get
  update:
    x-apievangelist-phrasing:
      intent: List review site aliases for a business
      effect: read
      questions:
      - What source alias names can I use when adding a review site URL?
      - Where do I find the review site alias list for a location?
      instructions:
      - text: Get the review site aliases available to business {businessId}.
        slots:
          businessId: query.businessId
      - text: Look up the sourceAlias values I can use for business {businessId}.
        slots:
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation/business/{business_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a review site URL to aggregate
      effect: write
      questions:
      - Can I add a review site page URL so its reviews get aggregated for my business?
      - What do I need to supply to start aggregating reviews from a new site?
      instructions:
      - text: Add aggregation URL {url} for source {sourceAlias} to business {business_id}.
        slots:
          url: requestBody.url
          sourceAlias: requestBody.sourceAlias
          business_id: path.business_id
      - text: Start pulling reviews from {sourceAlias} for business {business_id}.
        slots:
          sourceAlias: requestBody.sourceAlias
          business_id: path.business_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/aggregation/business/{businessID}/aggregation/{aggregationID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a review aggregation URL
      effect: destructive
      questions:
      - Can I stop aggregating reviews from a site I added by mistake?
      - Is there a way to delete one aggregation URL from a business?
      instructions:
      - text: Delete aggregation {aggregationID} from business {businessID}.
        slots:
          aggregationID: path.aggregationID
          businessID: path.businessID
      - text: Remove the review site aggregation {aggregationID} on business {businessID}.
        slots:
          aggregationID: path.aggregationID
          businessID: path.businessID
      method: generated
      generated: '2026-09-26'