v1Resources/Reviews/getGet a review analytics summary
Get a review analytics summary
Review analytics aggregated across this client's (or the whole agency's) locations: count, average rating, rating distribution, sentiment mix, response rate, per-platform breakdown, and a monthly trend. Scope to a subset with tags.
get
reviews:read/api/v1/reviews/analytics/summaryQuery parameters
clientIdstringoptional
Limit to one client's locations.
tagsstringoptional
Comma-separated location tag names — only locations carrying at least one of these are included.
monthsintegeroptional
Trend length in months. Default 6.
Response
dataobjectoptional
locationsnumberoptional
Number of locations in scope.
countnumberoptional
Total reviews in scope.
avgRatingnumberoptional
Average rating across the scope.
distributionobjectoptional
Review count per star rating (1-5).
sentimentobjectoptional
Review count by sentiment.
positivenumberoptional
neutralnumberoptional
negativenumberoptional
responseRatenumberoptional
Percentage of reviews with a reply.
byPlatformarray of objectoptional
Count and average rating per platform.
platformstringoptional
countnumberoptional
avgRatingnumberoptional
trendarray of objectoptional
Monthly count and average rating.
monthstringoptional
countnumberoptional
avgRatingnumberoptional
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/reviews/analytics/summary
Your API key
clientId
tags
months
{}