Birdeye

Birdeye Competitor AI API

Competitive intelligence, simplified by AI.

Documentation GitHub OpenAPI

Business capability

Market Intelligence Management BC-400.30

Operations 2

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/competitors/review Retrieve competitors' reviews · Retrieve Competitor Reviews #

Ask an LLM

“Can I pull the actual reviews my competitors received over a date range?”

“Can I filter competitor reviews by brand, source, or competitor location?”

Tell an agent

Retrieve competitor reviews for locations {businessNumbers} from {fromDate} to {toDate}.

Get the review text left for competitor brands {brandIds}.

POST /v1/competitors/review/metrics Get competitor review metrics · Retrieve Competitor Review metrics #

Ask an LLM

“What are my competitors' review counts and average ratings?”

“Can I get aggregated review metrics per competitor location instead of the review text?”

Tell an agent

Get competitor review metrics for {businessNumbers} between {fromDate} and {toDate}.

Show review metrics for competitor locations {competitorLocationIds}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/birdeye:birdeye-competitor-ai-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Birdeye Competitor AI API
  version: '1.0'
  description: 'Operations tagged Competitor AI across 2 of this provider''s published API definitions: birdeye-birdeye-api-openapi.yml, birdeye-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.birdeye.com
  description: Production
- url: https://api.birdeye.com/resources
tags:
- name: Competitor AI
  description: Competitive intelligence, simplified by AI.
paths:
  /v1/competitors/review:
    post:
      summary: Retrieve Competitor Reviews
      operationId: retrieve-competitor-reviews
      tags:
      - Competitor AI
      parameters:
      - name: startIndex
        in: query
        required: false
        description: The starting index for pagination (0-based). Default is 0.
        schema:
          type: number
        example: '0'
      - name: pageSize
        in: query
        required: false
        description: 'Number of records to return per page (max recommended: 100). Default is 25.'
        schema:
          type: number
        example: '25'
      - name: sortOrder
        in: query
        required: false
        description: 'Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 1.'
        schema:
          type: number
        example: '1'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1167
                  message: API key is missing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessNumbers:
                  type: array
                fromDate:
                  type: string
                toDate:
                  type: string
                sources:
                  type: array
                brandIds:
                  type: array
                competitorLocationIds:
                  type: array
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
  /v1/competitors/review/metrics:
    post:
      summary: Retrieve Competitor Review metrics
      operationId: retrieve-competitor-review-metrics
      tags:
      - Competitor AI
      parameters:
      - name: startIndex
        in: query
        required: false
        description: The starting index for pagination (0-based). Default is 0.
        schema:
          type: number
        example: '0'
      - name: pageSize
        in: query
        required: false
        description: 'Number of records to return per page (max recommended: 100). Default is 25.'
        schema:
          type: number
        example: '25'
      - name: sortOrder
        in: query
        required: false
        description: 'Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 0.'
        schema:
          type: number
        example: '0'
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: 1167
                  message: API key is missing
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                businessNumbers:
                  type: array
                fromDate:
                  type: string
                toDate:
                  type: string
                sources:
                  type: array
                brandIds:
                  type: array
                competitorLocationIds:
                  type: array
      security:
      - apiKey: []
    servers:
    - url: https://api.birdeye.com
      description: Production
components:
  schemas:
    Apiary_retrieveCompetitorReviews_Response200:
      type: object
      properties:
        businessLocations:
          type: array
          items:
            type: object
            properties:
              businessId:
                type: number
                description: The unique identifier for the business
              name:
                type: string
                description: The name of your business location being analyzed
              alias:
                type: string
                description: The alias for the business location
              businessNumber:
                type: number
                description: Business number for the location
              phone:
                type: string
                description: Phone number of the location
              address:
                type: string
                description: Address of the business location
          description: The list of business locations being analyzed
        competitorLocation:
          type: string
          description: The name of the competitor location where the review was left
        competitorBrand:
          type: string
          description: The brand name or identifier of the competitor
        source:
          type: string
          description: The review platform/source where the review was published
        rating:
          type: number
          description: The star rating given by the reviewer (1-5 scale)
        reviewComment:
          type: string
          description: The actual text content of the review written by the customer
        reviewerName:
          type: string
          description: The name of the person who wrote the review
        reviewDate:
          type: string
          description: The date when the review was published (YYYY-MM-DD format)
        reply:
          type: string
          description: The business owner's response to the review (if any)
    Apiary_retrieveCompetitorReviewMetrics_Response200:
      type: object
      properties:
        businessLocations:
          type: object
          description: The list of business locations being analyzed
          properties:
            businessId:
              type: number
              description: The unique identifier for the business
            name:
              type: string
              description: The name of your business location being analyzed
            alias:
              type: string
              description: The alias for the business location
            businessNumber:
              type: number
              description: Business number for the location
            phone:
              type: string
              description: Phone number of the location
            address:
              type: string
              description: Address of the business location
        competitorLocation:
          type: string
          description: The name of the competitor location where the review was left
        competitorBrand:
          type: string
          description: The brand name or identifier of the competitor
        source:
          type: string
          description: The review platform/source where the review was published
        overallRating:
          type: number
          description: The average rating for this competitor location on this specific source
        reviewCount:
          type: number
          description: The total number of reviews for this competitor location on this specific source
    1167Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1167
        message: API key is missing
    89Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 89
        message: Rate limit exceeded
    1011Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1011
        message: Business id is invalid
    1161Model:
      type: object
      properties:
        code:
          type: number
        message:
          type: string
      example:
        code: 1161
        message: Invalid API key
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Partner specific API key provided by Birdeye for data exchange.
x-refined-from:
- birdeye-birdeye-api-openapi.yml
- birdeye-openapi-original.yml