Skip to main content
POST
Competitive Ranking Report

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

businessId
number
required

Id of the Business.

Response

OK

positiveCount
number

Number of positive keywords.

neutralCount
number

Number of neutral keywords.

negativeCount
number

Number of negative keywords..

positivePercent
number

Positive keyword percentage.

neutralPercent
number

Neutral keyword percentage.

negativePercent
number

Negative keyword percentage.

name
string

Enterprise name.

count
number

Total Count.

rating
number

Average rating.

competitors
object[]

Competitors data.