# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Birdeye Listing API
  version: 1.0.0
extends: openapi/birdeye-listing-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: 16
- target: $.paths['/v1/listing/fix'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a listing fix for a business
      effect: write
      questions:
      - Can I trigger a fix for a location's inaccurate listings?
      - Is there a way to push corrections out to a business's listings?
      instructions:
      - text: Fix listings for business {b_id}.
        slots:
          b_id: query.b_id
      - text: Run a listing fix on {b_id}.
        slots:
          b_id: query.b_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/status/location'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location's listing status report
      effect: read
      questions:
      - What is the listing status on each site for my location?
      - Can I get a listing status report for one location?
      instructions:
      - text: Get the listing status report for {businessNumber}.
        slots:
          businessNumber: query.businessNumber
      - text: Show listing sync status for location {businessNumber}.
        slots:
          businessNumber: query.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/insights'].post
  update:
    x-apievangelist-phrasing:
      intent: Get listing insights
      effect: read
      questions:
      - Can I get listing insights for my locations over a date range?
      - Can listing insights be viewed in different view modes?
      instructions:
      - text: Get listings insights for account {businessId} in view mode {viewMode}.
        slots:
          businessId: query.businessId
          viewMode: requestBody.viewMode
      - text: Show listing insights for {businessNumbers} from {startDate} to {endDate}, account {businessId}, mode {viewMode}.
        slots:
          businessNumbers: requestBody.businessNumbers
          startDate: requestBody.startDate
          endDate: requestBody.endDate
          businessId: query.businessId
          viewMode: requestBody.viewMode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/report/{reportType}/datapoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Get datapoints for a listing report type
      effect: read
      questions:
      - Can I get datapoints for one listing report type, like search views or customer actions?
      - Can I group listing datapoints by a period?
      instructions:
      - text: Get {reportType} datapoints for account {businessId}.
        slots:
          reportType: path.reportType
          businessId: query.businessId
      - text: Pull {reportType} listing datapoints for {businessNumbers} grouped by {groupByType}, account {businessId}.
        slots:
          reportType: path.reportType
          businessNumbers: requestBody.businessNumbers
          groupByType: requestBody.groupByType
          businessId: query.businessId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/gmb-attributes-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Google Business Profile attributes
      effect: read
      questions:
      - Which Google Business Profile attributes apply to my category?
      - Can I list GMB attributes for a particular country and category?
      instructions:
      - text: Get GMB attributes for {businessNumber} in category {categoryId}, country {countryCode}.
        slots:
          businessNumber: path.businessNumber
          categoryId: query.categoryId
          countryCode: query.countryCode
      - text: List Google attributes for category {categoryId} in {countryCode} for location {businessNumber}.
        slots:
          categoryId: query.categoryId
          countryCode: query.countryCode
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/apple-location-attributes-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List Apple location attributes
      effect: read
      questions:
      - Which Apple location attributes can I set on my listing?
      - Can I see the attribute options available for an Apple listing?
      instructions:
      - text: Get Apple location attributes for {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: List the Apple listing attributes available to {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/apple-action-links'].get
  update:
    x-apievangelist-phrasing:
      intent: List Apple action links
      effect: read
      questions:
      - What Apple action links can be added to my location?
      - Can I see the action link types available for Apple listings?
      instructions:
      - text: Get Apple action links for {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: List Apple listing action links for location {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/category-list'].get
  update:
    x-apievangelist-phrasing:
      intent: List business categories for a listing source
      effect: read
      questions:
      - Which business categories can I choose on a given listing site?
      - Can I get the category list for a specific country?
      instructions:
      - text: Get the {sourceName} category list for {businessNumber} in {countryCode}.
        slots:
          sourceName: query.sourceName
          businessNumber: path.businessNumber
          countryCode: query.countryCode
      - text: List categories from {sourceName} available in {countryCode} for location {businessNumber}.
        slots:
          sourceName: query.sourceName
          countryCode: query.countryCode
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a location listing
      effect: write
      questions:
      - Can I create a listing with business info and media for a new location?
      - Can I set up a new location's listing including Apple and Facebook data?
      instructions:
      - text: Create a listing for {businessNumber} with business info {businessInfo}.
        slots:
          businessNumber: path.businessNumber
          businessInfo: requestBody.businessInfo
      - text: Set up a new listing on {businessNumber} with media {media}.
        slots:
          businessNumber: path.businessNumber
          media: requestBody.media
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing listing
      effect: write
      questions:
      - Can I update an existing listing's business info?
      - Can I opt a listing out of certain sites when updating it?
      instructions:
      - text: Update the listing of {businessNumber} with business info {businessInfo}.
        slots:
          businessNumber: path.businessNumber
          businessInfo: requestBody.businessInfo
      - text: Change the existing listing for {businessNumber}, opting out of {optOut}.
        slots:
          businessNumber: path.businessNumber
          optOut: requestBody.optOut
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/get'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a location's listing
      effect: read
      questions:
      - What listing data does Birdeye hold for my location?
      - Can I read back the full listing I set up for a location?
      instructions:
      - text: Get the listing for {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: Show the current listing details of location {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/more-hours-type'].get
  update:
    x-apievangelist-phrasing:
      intent: List more-hours types for a channel
      effect: read
      questions:
      - Which more-hours types are available for Google or Apple listings?
      - Can I fetch more-hours options for one channel?
      instructions:
      - text: Get more hours types for {businessNumber} on channel {channel}.
        slots:
          businessNumber: path.businessNumber
          channel: query.channel
      - text: List {channel} more-hours types for location {businessNumber}.
        slots:
          channel: query.channel
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/gmb/keywords'].post
  update:
    x-apievangelist-phrasing:
      intent: Get Google search keyword counts
      effect: read
      questions:
      - Which search keywords drove people to my Google profile in a month?
      - Can I see keyword search counts across several locations?
      instructions:
      - text: Get Google keyword counts for {businessNumber} in {selectedMonth}.
        slots:
          businessNumber: path.businessNumber
          selectedMonth: requestBody.selectedMonth
      - text: Show Google search keyword counts for {selectedMonth} matching {keywordsSearch} on {businessNumber}.
        slots:
          selectedMonth: requestBody.selectedMonth
          keywordsSearch: requestBody.keywordsSearch
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/{businessNumber}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a location's listing
      effect: destructive
      questions:
      - Can I deactivate a location's listing?
      - Is there a way to stop managing the listing for a closed location?
      instructions:
      - text: Deactivate the listing for {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      - text: Turn off listing management for location {businessNumber}.
        slots:
          businessNumber: path.businessNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/menu-details'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrieve listing menu details
      effect: read
      questions:
      - Can I pull the menu details stored on my location listings?
      - Which locations have menu information on their listings?
      instructions:
      - text: Retrieve menu details for {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      - text: Get listing menus for locations {businessNumbers}.
        slots:
          businessNumbers: requestBody.businessNumbers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/listing/get/hotel-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get hotel attributes for a business
      effect: read
      questions:
      - Which hotel attributes apply to my property's listing?
      - Can I fetch the configured hotel attributes for a business?
      instructions:
      - text: Get hotel attributes for business {businessNumber}.
        slots:
          businessNumber: header.x-business-number
      - text: List the hotel listing attributes configured for {businessNumber}.
        slots:
          businessNumber: header.x-business-number
      method: generated
      generated: '2026-09-26'