Skip to main content

Description

Returns review count and average rating for each location. Use it to find the highest-rated, lowest-rated, most-reviewed, or least-reviewed branches.

Parameters

Example Usage

Example Response

Response Fields

Notes

  • For the highest or lowest result, choose sortBy and sortOrder in the tool call and use the first returned location, or read lowestRated/highestRated directly.
  • The location name field is label (inside dataPoints) and the location ID field is businessNumber — not milestone/businessId as used by the sibling by-source and by-time report tools. No state field is present.
  • Calling with a relative window (e.g. days: 30) and no businessNumbers returned a 500 error in testing on an account with many locations. The same request scoped with businessNumbers succeeded. Prefer passing businessNumbers when scoping this report on large accounts.
  • On accounts with many locations, an unscoped call can return a very large dataPoints array. Pass businessNumbers to keep the response manageable.
  • Use get_review_and_rating_over_time for trends.