Skip to main content

​
Description

Returns aggregated review metrics for competitor locations — average rating and total review count grouped by competitor location and review source. Use this for a quick competitive benchmark without fetching full review content. Each metric record includes:
  • businessLocations — your business locations associated with this competitor (businessId, name, alias, businessNumber, phone, address)
  • competitorLocation — the competitor location name
  • competitorBrand — the competitor brand name
  • source — review platform (e.g. "Google", "Yelp")
  • overallRating — average star rating for this competitor location on this source
  • reviewCount — total number of reviews for this competitor location on this source

​
Parameters

​
Required

​
Optional

​
Example Usage

​
Notes

  • To scope by location name, call get_child_locations first, match the location by name/alias, then pass its businessNumber in businessNumbers.
  • Maximum 5 brandIds per request.