Skip to main content
POST
Retrieve Competitor Review metrics

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.

x-business-number
string

e.g. [Required] User assosiated businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

startIndex
number

The starting index for pagination (0-based). Default is 0.

pageSize
number

Number of records to return per page (max recommended: 100). Default is 25.

sortOrder
number

Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 0.

Body

application/json
businessNumbers
any[]

Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.

fromDate
string

Start date for the analysis period.

toDate
string

End date for the analysis period.

sources
any[]

Aggregation sources.

brandIds
any[]

Filter by specific competitor brand IDs. Maximum 5 brand IDs are allowed.

competitorLocationIds
any[]

Filter by specific competitor location IDs.

Response

OK

businessLocations
object

The list of business locations being analyzed

competitorLocation
string

The name of the competitor location where the review was left

competitorBrand
string

The brand name or identifier of the competitor

source
string

The review platform/source where the review was published

overallRating
number

The average rating for this competitor location on this specific source

reviewCount
number

The total number of reviews for this competitor location on this specific source