> ## Documentation Index
> Fetch the complete documentation index at: https://docs.birdeye.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Competitive Insight Keywords
> Get Keyword Statistics retrieves Insights keywords details for a competitor.
## OpenAPI
````yaml api/openapi.yaml POST /v1/competitors/competitive-insight/keywords/{businessNumber}
openapi: 3.0.0
info:
title: Birdeye
version: 0.0.1
description: >-
Birdeye helps businesses grow through happy customers. Over 80,000
businesses use Birdeye everyday to attract new leads with Listings, Reviews
and Referrals, convert them into customers with Webchat, Appointments, and
Payments, and delight those customers with Surveys, Ticketing, and Insights
- all in one place.
The Birdeye APIs are built on HTTP and are RESTful APIs.
* Uses resource-oriented URLs.
* Uses built-in HTTP capabilities for passing parameters and authentication.
* Responds with standard HTTP response codes to indicate errors.
* Requests and responses payload attached with all the mentioned APIs, you
may choose your preferred language per the integration requirement.
### Authentication and Rate limiting
> __NOTE:__
> - __All API requests targeting business accounts must include the
x-api-key header. This header is required and mandatory for successful
authentication and access to the API endpoints.__
>
> - __To protect your API key and prevent unauthorized access, please ensure
all API requests are made from your backend server. Do not call the APIs
directly from the browser or expose your API key in any client-side code.__
To call a Birdeye API, you need a valid API key. It can be fetched via the
Birdeye dashboard and is a confidential key.
There is a limit to calling APIs with each API key [connect with the support
team to get the current limit]. If too many requests are made within the
threshold timeframe, an error will be returned in the response.
### Pagination
Multiple API supporting pagination. These APIs have two parameters sindex
and count.
* sindex: is the start index
* count: No. of records, you want to fetch.
> __Note__
> - _Deep Pagination with record window greater than 100k is not supported.
Either reduce the sindex + count to be less than equal to 100k or use
appropriate filters to narrow down your result set._
For example :
* Suppose you have to fetch 20 records:
API call 1 -> sindex=0, count 10
API call 2 -> sindex -> 10, count 10.
* To fetch 100kth record:
sindex = 99000 and count = 1000
will just work fine as sindex + count = 100000 which is less than 100,000.
* If you fetch more than 100kth records:
sindex = 99000 and count = 1001, sindex + count = 100001
which is greater than 100,000. Thus, you'll receive an error in response.
### HTTP Status Codes
Every API response will have an HTTP status code.
* 200 - OK: API request is successful
* 202 - Accepted: The API request has been accepted for processing.
* 400 - Bad Request: The API request was unacceptable, often due to a
missing or invalid parameter.
* 404 - Not Found: The requested resource does not exist.
* 429 - Rate Limited: You have made too many requests within the
threshold timeframe.
* 500 - Internal Server Error: Something went wrong on our end.
Please get in touch with support.
### Error Response
Birdeye API will return a validation error in case of missing/invalid input
in the request. The response will return the errorCode and errorMessage.
For example :
{
"code": 1161,
"message": "Invalid API key"
}
servers:
- url: https://api.birdeye.com/resources
security: []
tags:
- name: Business
description: Create and maintain your business on Birdeye.
- name: Custom Fields
description: Create, delete , update , associate and get custom fields easily.
- name: User
description: Delete and manage user profiles and permissions easily.
- name: Reviews
description: Consistently generate more reviews and higher ratings.
- name: Contact
description: >-
Manage contacts across locations effortlessly with a robust Contact
Management System.
- name: Contact V2
description: >-
Easily manage contacts across multiple locations using enhanced Contact
APIs, featuring built-in support for communication preference flags.
- name: Campaign
description: >-
Create a short link for review requests and set review sources in the
template.
- name: Aggregation
description: Access your public data from 150+ review sites.
- name: Report
description: >-
Various reporting data points across Birdeye modules like reviews,
insights and competitors etc for all your data visualisation
- name: Survey
description: >-
Engage each customer at the right time with NPS or CSAT surveys to improve
your service.
- name: Business Media
description: >-
Add, delete and manage business media.
> __Supported Media Size__
> - _Photo: JPG or PNG. 720 x 720px. 10KB min._
> - _Video: 30 sec long. 720p or more upto 75MB._
> __Note__
> - _Uploaded media will be pushed to your google business profile (if
connected) and other long tail directories only._
- name: Social
description: Create and track Social posting for all channels.
- name: Employee
- name: Conversation
description: >-
Connect with customers across a range of digital channels from one unified
inbox.
- name: Subscription
description: >-
Subscribe or Unsubscribe multiple webhooks with different URLs or Events
for a subscription and deliver real-time notifications.
- name: Webhook
description: >-
Configure multiple webhooks with different URLs for a subscription and
deliver real-time notifications.
- name: Competitor
description: Make competitive insights your unfair advantage.
- name: Competitor AI
description: Competitive intelligence, simplified by AI.
- name: Insight AI
description: Insight intelligence, simplified by AI.
- name: Google Q&A
description: >-
> __Note__
> - _Applicable to be used only by paid listings clients, for their active
locations, for the Google Q&A section, in the Google listing_
- name: Google Services
description: >-
> __Note__
> - _Applicable to be used only by paid listings clients, for their active
locations, for the Google Services section, in the Google listing._
> - _No two services should have the same service name. It is recommended
that all services created should HAVE UNIQUE service names._
> - _You CAN have the same service across two diff categories e.g.:
Emergency counselling as a $100 paid service can be a service created &
mapped to category A - Mental health and category B - Psychotherapy - both
categories being present for the same location._
- name: FAQ
description: >-
To retrieve all Question and Answer (QnA) entries across locations using
FAQ APIs, enabling smart support and knowledge features for businesses.
- name: Listing
description: >-
Keep your business information accurate and consistent across 50+
websites.
- name: GMB Products
description: >-
To manage products, locations, and business details through Listing GMB
platform
- name: Search AI
description: >-
Search AI provides a comprehensive view of your business performance
across AI-powered search platforms, including data accuracy, sentiment
analysis, citations, brand ranking, and overall visibility.
- name: Ticketing
description: >-
Create standout customer support with ticketing across reviews, untagged,
and survey responses.
- name: Integration
description: Birdeye integrates with various software or tools you use.
- name: Change Logs
description: >-
* 07/03/2026 - Updated `mainBusinessDescription` and microsite
`internalListing.description` fields in Create, Update and Get Listing
APIs to be optional instead of required, with support for clearing the
existing value by sending an empty string (V2BIRD-1690).
* 06/10/2026 - Updated Get Contact API to support an optional
`experienceScore` boolean field in the request body (default: false). When
set to true, the response includes the customer's experience score and
source.
* 05/25/2026 - Added Update Custom card (PUT) and Delete Custom
card (DELETE) API documentation under the Business profile custom card
section.
* 05/11/2026 - Added support for backdated survey responses in the
POST Survey Response API. The `created` field (UTC Epoch milliseconds) is
optional; if omitted, the server defaults to the current UTC timestamp.
* 04/22/2026 - Provide subLocality field support in Get, Create and
Update Listings APIs for NZ Locations.
* 04/16/2026 - Added Archived Get Reviews API under Reviews group.
* 04/06/2026 - Updated Get Reviews API documentation to improve
clarity on review statuses and how to retrieve all review types.
* 03/24/2026 - Added Social Open URL Performance Report API and
Insight AI APIs to retrieve location-wise metrics and benchmark score.
* 03/18/2026 - Added Create Custom Card Time API under custom
fields section.
* 03/03/2026 - Added Response Time (overtime & by-location) and
Response Rate(overtime & by-location) APIs under reports section and
created group for Competitor AI.
* 03/02/2026 - Added sendInvite (boolean, default - true) field in
Create User Signup v2 API request body and attributes.
* 02/11/2026 - Updated the API key identifier for applicable APIs
by moving it from a query parameter to the x-api-key request header.
* 02/03/2026 - Added the "Get All QnA" API under FAQ group to
enable retrieval of QnA entries across business locations, with full
request and response documentation
* 01/19/2026 - Added a note under the Authentication and Rate
limiting section specifying that the x-api-key header is mandatory for all
API requests targeting EU region business accounts.
* 01/13/2026 - Added Create User (Signup) API under User module to
create and invite users for a business.
* 09/22/2025 - Added GMB Products APIs to onboard/connect Google
Merchant accounts and manage product listing actions.
* 08/21/2025 - Added Single main business description Support.
* 08/19/2025 - Added competitor /raptor public APIs for reviews
aggregates.
* 06/26/2025 - Added Contact V2 APIs with communication preference
flag support.
* 12/13/2024 - Added inline reply support for GetReviews APIs.
* 09/27/2024 - Added update for Google Opening Soon (BIRD-56987)
* 06/25/2024 - Updated Listings Insights API (BIRDEYE-137367)
* 05/29/2024 - Added Google Q&A Developers API Section
* 05/13/2024 - Added epoc date support for GetReviews APIs.
* 03/22/2024 - Add Update Hierarchy API (BIRD-32609)
* 03/19/2024 - Added Ticket APIs Create, Get, Update APIs under
Ticket module
* 02/26/2024 - Updated logoUrl description in Get, Update APIs
under Business module and Create, Get, Update APIs under Listing module
(BIRD-29386)
* 12/21/2023 - Add listing phase 2 api changes (BIRD-16589)
* 11/08/2023 - Add survey changes (BIRD-11944) and listing changes
(BIRD-14345)
* 11/08/2023 - Added CRUD APIs for Apple chat
* 10/15/2023 - Added CRUD APIs for Business Media.
* 10/11/2023 - Added new APIs under Listing module, Create, Update,
Get, Deactive Listings
* 09/18/2023 - Added new API under Contact module i.e, Get opt-out
contact data
* 08/25/2023 - Added new APIs under Business and Listing modules,
Get Category List API, Get GMB Attributes API & Get Timezone List
* 07/21/2023 - Added new API under Business module i.e, Business
Search API.
* 06/30/2023 - Added support for service area based information in
Get Business API and Update Business API.
* 10/04/2024 - Added support to fetch ticketId associated with the
survey responses in List Response API.
paths:
/v1/competitors/competitive-insight/keywords/{businessNumber}:
post:
tags:
- Competitor
summary: Get Keyword Statistics
description: >-
Get Keyword Statistics retrieves Insights keywords details for a
competitor.
operationId: getKeywordStatistics
parameters:
- name: businessNumber
in: path
description: Account Business Number.
required: true
example: '169744180007807'
schema:
type: string
- name: Accept
in: header
description: e.g. application/json
required: false
example: application/json
schema:
type: string
default: application/json
- name: x-api-key
in: header
description: >-
e.g. [Required] Partner specific API key provided by Birdeye for
data exchange.
required: false
example: >-
[Required] Partner specific API key provided by Birdeye for data
exchange.
schema:
type: string
- name: Content-Type
in: header
description: Media type of the JSON request body.
required: false
example: application/json
schema:
type: string
default: application/json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Apiary_getKeywordStatistics_Request'
example:
sourceType: review
sources:
- google
- citysearch
startDate: 11/02/2020
endDate: 01/06/2021
competitors:
- competitorId: 530846
compAccountIds:
- 162426
- 144352
- competitorId: 720708
compAccountIds:
- 165432
topKW: 25
topAd: 10
orderBy: ztoa
sentiment: -1
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Apiary_getKeywordStatistics_Response200'
example:
id: 119468
name: Social Stress
keywords:
- experience
ct: 27159
avgScr: 1
keywordStats:
- keyword: experience
occurences: 27158
score: 1
scr: 27158
- keyword: lady
occurences: 2186
score: 1
scr: 2186
negKWAdjectives:
- adjective: horrible
occurences: 4137
avgScore: 1
prcnt: 15.232519
competitors:
- id: 159180
name: Online Competitors
keywords:
- experience
ct: 1176
avgScr: 1
keywordStats:
- keyword: problem
occurences: 2972
score: 1
scr: 2972
negKWAdjectives:
- adjective: bad
occurences: 340
avgScore: 1
prcnt: 28.911564
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/1161Model'
x-apiary-response-models:
- $ref: '#/components/schemas/1161Model'
- $ref: '#/components/schemas/1167Model'
x-apiary-response-examples:
error_1161:
value:
code: 1161
message: Invalid API key
error_1167:
value:
code: 1167
message: API key is missing
examples:
response:
value:
code: 1161
message: Invalid API key
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/1011Model'
examples:
response:
value:
code: 1011
message: Business id is invalid
'429':
description: Too Many Requests
content:
application/json:
schema:
$ref: '#/components/schemas/89Model'
examples:
response:
value:
code: 89
message: Rate limit exceeded
components:
schemas:
Apiary_getKeywordStatistics_Request:
type: object
properties:
sourceType:
type: string
description: Type of source e.g. review [by default] or social.
sources:
type: array
items: {}
description: Aggregation sources.
timePeriodSelected:
type: string
description: 'For all time : all.'
startDate:
type: string
description: Date from which data has to be fetched[MM/DD/YYYY].
endDate:
type: string
description: Date until which data has to be fetched[MM/DD/YYYY].
competitors:
type: array
items:
type: object
properties:
competitorId:
type: number
description: >-
Enterprise Competitor Ids [competitorId in Competitor of
Enterprise Business API].
compAccountIds:
type: array
items: {}
description: >-
Locations Ids of competitor account [compAccountIds in Child
Business of Competitor API].
description: List of competitors
topKW:
type: number
description: Count of top Keywords to be fetched.
topAd:
type: number
description: Count of top Adjectives to be fetched.
orderBy:
type: string
description: 'Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"'
sentiment:
type: number
description: '-1 = negative sentiment,'
example:
sourceType: review
sources:
- google
- citysearch
startDate: 11/02/2020
endDate: 01/06/2021
competitors:
- competitorId: 530846
compAccountIds:
- 162426
- 144352
- competitorId: 720708
compAccountIds:
- 165432
topKW: 25
topAd: 10
orderBy: ztoa
sentiment: -1
Apiary_getKeywordStatistics_Response200:
type: object
properties:
id:
type: number
example: 119468
description: Business Id
name:
type: string
example: Social Stress
description: Name of Enterprise
keywords:
type: array
items: {}
description: List of keywords.
ct:
type: number
example: 27159
description: Count.
avgScr:
type: number
example: 1
description: Average Score.
keywordStats:
type: array
items:
type: object
properties:
keyword:
type: string
description: Keyword
occurences:
type: number
description: Occurences
score:
type: number
description: Score
scr:
type: number
description: Scr.
negKWAdjectives:
type: array
items:
type: object
properties:
adjective:
type: string
description: Adjectives
occurences:
type: number
description: Occurences
prcnt:
type: number
description: Percentage
avgScore:
type: number
description: Average Score
description: Negative keyword details
competitors:
type: array
items:
type: object
properties:
id:
type: number
description: Business Id
name:
type: string
description: Name of Enterprise
keywords:
type: array
items: {}
description: List of keywords.
ct:
type: number
description: Count.
avgScr:
type: number
description: Average Score.
keywordStats:
type: array
items:
type: object
properties:
keyword:
type: string
description: Keyword
occurences:
type: number
description: Occurences
score:
type: number
description: Score
scr:
type: number
description: Scr.
negKWAdjectives:
type: array
items:
type: object
properties:
adjective:
type: string
description: Adjectives
occurences:
type: number
description: Occurences
prcnt:
type: number
description: Percentage
avgScore:
type: number
description: Average Score
description: Negative keyword details
description: Competitor details
1161Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1161
message: Invalid API key
1011Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 1011
message: Business id is invalid
89Model:
type: object
properties:
code:
type: number
message:
type: string
example:
code: 89
message: Rate limit exceeded
````