Skip to main content
POST
Retrieve Competitor Reviews

Headers

Accept
string

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

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 1.

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 id.

competitorLocationIds
any[]

Filter by specific competitor location IDs.

Response

OK

The response is of type object.