Partner reviews by publisher (lifetime)

Returns per-publisher lifetime totals (all-time review count + overall rating from the synced per-store review-site connections, hipages via bridge) plus the selected-period review count and rating, scoped to the partner.

Auth: Partner — authentication; under partner/report group. Store set precedence: store_id → single store; else account_id (account); else all partner stores. Note: this handler does NOT translate client_location_id/client_account_id to ids (unlike its by-site sibling) — pass store_id/account_id directly. All id params guarded by an ownership check.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
range_startstringyesY-m-d H:i:s
range_endstringyesY-m-d H:i:s
store_idintegernobelongs to auth company
account_idintegernoaccount (bundle_id=3) under this partner
client_location_idstringnovalidated but NOT resolved by this handler
client_account_idstringnovalidated but NOT resolved by this handler

Response{ data: [.] } envelope; one row per publisher with history, sorted most-reviewed first.

  • id (int) — review_site id
  • review_site (string) — display name (maps.googleGoogle)
  • review_site_logo (string) — S3 logo URL
  • review_site_color (string|null)
  • total_reviews (int) — lifetime/all-time total
  • overall_rating (float|null) — count-weighted lifetime rating
  • period_reviews (int) — reviews within the date range
  • period_rating (float|null) — average rating within range
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
integer
Responses

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