Review-response feed

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:
FieldTypeRequiredNotes
range_startstring Y-m-d H:i:soptionalStart of the review-date window; pair with range_end.
range_endstring Y-m-d H:i:soptionalEnd of window. If both range bounds are present and limit is omitted, the feed returns the full result set (no pagination); otherwise it paginates.
limitintegeroptionalPage size. Default 10 (25 for hipages users, who are also hard-capped at 25).
pageintegeroptionalPage number.
sort_fieldstringoptionalSort column.
sort_bystringoptionalOne of asc,ASC,desc,DESC.
typestringoptionalOne of report,download.
store_idintegeroptionalMust be an existing location and must belong to the auth company tree. Narrows scope to one store.
client_location_idstring (max 255)optionalAlternative to store_id; resolved to a store. Tree-scoped.
account_idintegeroptionalMust be an existing account with bundle_id=3 (an account), not soft-deleted; tree-scoped. Narrows to that account's stores.
client_account_idstring (max 255)optionalAlternative to account_id;. Tree-scoped.
is_pdfintegeroptional0 or 1; switches review-site logos to local asset paths.
review_site_idintegeroptionalFilter feed to one publisher.
ratinginteger or array of integersoptionalA scalar is normalized to an array in prepareForValidation. Each element must be an integer.
statusstringoptionalResponse state: one of complete,pending,escalate pending,escalated,error,flagged,removed.
searchstring (max 255)optionalKeyword 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[] — one ResponseFeed item per review:
  • id (int) — review id.
  • source_platform (string) — originating platform (the review site's name as-is), falling back to the normalised review-site slug.
  • review (object) — id, reviewer, rating, message, review_date (null when 0000-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; else connection_status==='connected').
  • flag (array) — status-flag chips (flag, title, statusColor, icon, optional links); '' when you set standalone_type.
  • plan (string) — plan name from the latest UpdatedReviewResponse, 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 when 0000-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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
integer
integer
rating
array of integers
rating
string
string
integer
integer
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json