Retrieve Competitor Review Metrics
This API retrieves competitor metrics review data (average rating and total reviews) for specified business numbers and date ranges.
Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
e.g. [Required] User assosiated businessNumber
Media type of the JSON request body.
Query Parameters
The starting index for pagination (0-based). Default is 0.
Number of records to return per page (max recommended: 100). Default is 25.
Sort order: 0 = Ascending, 1 = Descending order of review date. Default is 0.
Body
Location numbers of enterprise locations. If empty all valid enterprise locations will be selected.
Start date for the analysis period.
End date for the analysis period.
Aggregation sources.
Filter by specific competitor brand IDs. Maximum 5 brand IDs are allowed.
Filter by specific competitor location IDs.
Response
OK
The list of business locations being analyzed
The name of the competitor location where the review was left
The brand name or identifier of the competitor
The review platform/source where the review was published
The average rating for this competitor location on this specific source
The total number of reviews for this competitor location on this specific source