Returns a paginated review-response feed across the partner's whole company tree, plus an overall average rating and a per-publisher KPI tile strip (hipages tile uses the bridge formula; all others use a simple AVG of rated rows).
Auth: Partner — authentication, mounted under the partner prefix (partner-admin user, bundle_id=1). Scope defaults to every store under the authenticated user. Narrowing params (store_id/client_location_id, account_id/client_account_id) must pass an ownership check, so the partner can only reach stores/accounts inside its own hierarchy. Same controller method as the account-side alias (Review-response feed (account-friendly route alias)); the partner role reaches a wider default scope.
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. If both range bounds are present and limit is omitted, the feed returns the full result set (no pagination); otherwise it paginates. |
limit | integer | optional | Page size. Default 10 (25 for hipages users, who are also hard-capped at 25). |
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 and must belong to the auth company tree. Narrows scope to one store. |
client_location_id | string (max 255) | optional | Alternative to store_id; resolved to a store. Tree-scoped. |
account_id | integer | optional | Must be an existing account with bundle_id=3 (an account), not soft-deleted; tree-scoped. Narrows to that account's stores. |
client_account_id | string (max 255) | optional | Alternative to account_id;. Tree-scoped. |
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 | A scalar is normalized to an array in prepareForValidation. Each element must be an integer. |
status | string | optional | Response state: 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 ( resource collection with additional meta + pagination meta).
data[]— oneResponseFeeditem per review:id(int) — review id.source_platform(string) — originating platform (the review site'snameas-is), falling back to the normalised review-site slug.review(object) —id,reviewer,rating,message,review_date(null when0000-00-00 00:00:00).reviewsite(object) —id,name(Maps.Google → Google),link,review_site_logo,review_site_color,auth_type,scraping_enabled(bool),posting_enabled(bool).store(object) —id,name(appends- {storeid}when present),slug,address(composed from company address/city/state).store_reviewsite(object) —id,url,landing_page_url,connection_status,is_connected(bool, per-site derived: Google id 44 = token present; Facebook id 3 = token+external_id; Caring id 20 = external_id; elseconnection_status==='connected').flag(array) — status-flag chips (flag,title,statusColor,icon, optionallinks);''when you setstandalone_type.plan(string) — plan name from the latestUpdatedReviewResponse, or''.review_flag(object|null) — raw flag model.is_flaggable(bool) — full flag-policy result.flag_status(string) — flag-status enum value, or'none'.flag_details(object|null) —reason,reason_identifier,flag_reason_detail,flag_date(ISO-8601), populated only when a flag row exists.response_capabilities(object) — universal result gating Submit / Request-Revision.response(object|null) —id,status,public_contents,private_contents,response_date(null when0000-00-00 00:00:00),deleted; null when absent or an unverified auto-response.- hipages-only (present only when the row is a hipages-partner review):
flagging(window_days,expires_at,reason),is_legacy,is_qualified,is_off_platform,classification_label,job_id,sub_dimensions,is_profanity,badges,has_history,moderation(suppressed_at/excluded_from_rating_at/hidden_from_public_at/released_to_public_at/deleted_at). avg_rating(float) — overall average rating across the scoped stores, rounded to 2dp (additional meta).kpi_by_publisher(array) — one tile per publisher with reviews in scope:review_site_id,review_site_name,review_site_color,rating(float|null),total_reviews(int),was_bridged(bool; true for the hipages bridge tile).[]when no stores in scope (additional meta).- Pagination meta (
current_page,last_page,per_page,total, links) present when the result is paginated.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
