Account-friendly alias of the review-response feed (Review-response feed) — same controller method, mounted under reports/response so an account user reading their own reviews and a partner-admin reading across accounts both work. Returns the paginated feed, overall avg_rating, and the per-publisher KPI strip.
Auth: Both — authentication, mounted at the top-level reports/response group (no partner/account prefix, role-agnostic). The reachable scope follows the caller's own auth company tree: with no narrowing params the feed defaults to every store under the authenticated user, so an account-tradie sees only their stores while a partner-admin sees their whole tree. store_id/client_location_id and account_id/client_account_id must sit inside your own account tree, which resolves client_* identifiers differently for account (bundle_id=3) vs partner (bundle_id=1) callers. So the reachable set differs per role even though the params are identical.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
range_start | string Y-m-d H:i:s | optional | Start of the review-date window; pair with range_end. |
range_end | string Y-m-d H:i:s | optional | End of window. Both bounds present and limit omitted ⇒ full (unpaginated) result; otherwise paginated. |
limit | integer | optional | Page size. Default 10 (25 + hard cap 25 for hipages users). |
page | integer | optional | Page number. |
sort_field | string | optional | Sort column. |
sort_by | string | optional | One of asc,ASC,desc,DESC. |
type | string | optional | One of report,download. |
store_id | integer | optional | Must be an existing location; tree-scoped via an ownership check. Narrows to one store. |
client_location_id | string (max 255) | optional | Alternative to store_id;. Tree-scoped. |
account_id | integer | optional | Must be an existing account with bundle_id=3, not soft-deleted; tree-scoped. Narrows to that account's stores. |
client_account_id | string (max 255) | optional | Alternative to account_id;. Tree-scoped; account vs partner resolution differs (see Auth). |
is_pdf | integer | optional | 0 or 1; switches review-site logos to local asset paths. |
review_site_id | integer | optional | Filter feed to one publisher. |
rating | integer or array of integers | optional | Scalar normalized to array in prepareForValidation. |
status | string | optional | One of complete,pending,escalate pending,escalated,error,flagged,removed. |
search | string (max 255) | optional | Keyword search over reviewer/customer name, review body, review title, hipages job id, or store/location name. |
Response — { data: [.] } envelope (identical shape to Review-response feed; same ResponseFeed resource + avg_rating / kpi_by_publisher additional meta + pagination meta).
data[]— per review:id,source_platform,review(id/reviewer/rating/message/review_date),reviewsite(id/name/link/review_site_logo/review_site_color/auth_type/scraping_enabled/posting_enabled),store(id/name/slug/address),store_reviewsite(id/url/landing_page_url/connection_status/is_connected),flag(chip array),plan,review_flag,is_flaggable,flag_status,flag_details,response_capabilities,response(or null), plus the hipages-only block (flagging,is_legacy,is_qualified,is_off_platform,classification_label,job_id,sub_dimensions,is_profanity,badges,has_history,moderation) when the row is a hipages review.avg_rating(float) — overall average across scoped stores, 2dp.kpi_by_publisher(array) — per-publisher tiles (review_site_id,review_site_name,review_site_color,rating,total_reviews,was_bridged);[]when no stores in scope.- Pagination meta (
current_page,last_page,per_page,total) when paginated.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||