get
https://production-api.shoutaboutus.com/api/v1/account/dashboard/get-review-site-distribution
Review-site distribution for the account dashboard: review counts and average ratings per platform. When no review_site_id filter is applied and there are more than 5 platforms, the top 4 are returned plus a rolled-up "Others" row (weighted-average rating). Ratings/counts are bridge-aware for hipages platforms.
Auth: Account — authentication, under the account/dashboard group (role-agnostic). Scope is the caller's company tree: store_id (if given) validated by an ownership check; otherwise all of the caller's stores.
Rate limit: No rate limit.
Request
- Query:
store_id(integer, optional) — must belong to the caller's company; omit it to cover all of your locations. - Query:
review_site_id(integer, optional) — filter to one platform; must be an existing review site. When set, the top-5/Others rollup is disabled. - Query:
range_start(stringY-m-d, optional) — both range params must be present for the date filter to apply. - Query:
range_end(stringY-m-d, optional) — must be ≥range_start.
Response — { data: [.] } envelope; an array of platform rows ordered by review count desc.
name(string) — review site name (e.g.maps.google,Facebook, orOthers).total_reviews(integer) — review count for the platform (bridge-unified for hipages).avg_rating(number) — average rating to 2 decimals (bridge-aware for hipages).logo(string) — S3 URL of the platform logo image.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
