Response report — by site

Returns review/response metrics grouped by review site (publisher) for the authenticated account — per-site review count, average rating, % of total, response count, response rate.

Auth: Account — authentication; under the account-side reports/response group. Scope: store_id → single store (guarded by an ownership check); else all of the auth user's stores. No account_id/client_* params on this account variant.

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

Response{ data: [.] } envelope; array of per-site rows.

  • id (int) — review_site id
  • review_site (string) — lowercased name (maps.googlegoogle)
  • review_site_logo (string|null) — S3 logo URL
  • total_reviews (int) / avg_rating (float)
  • per_of_total (float) — % of total reviews
  • total_response (int) / per_total_response (float) — response rate %

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
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