Response report — by location

Returns a paginated per-location (per-store) response table for the authenticated account — reviews, responses, average response time, average rating, 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. This account variant has NO account_id/client_* params — partner-wide scoping uses the partner/report/review-response/by-location endpoint instead.

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
sort_fieldstringnolocation_name,total_reviews,total_responses,avg_resp_time,avg_rating,response_rate (default location_name)
sort_bystringnoasc/ASC/desc/DESC (default ASC)
search_fieldstringnoonly location_name
search_valuestringno
limitintegerno10–100, values below 10 are raised to 10 (default 10)
pageintegernomin 1

Response — paginated ReviewResponseReport collection.

  • data[].id (int) — store id
  • data[].location_name (string) — name - storeid
  • data[].total_reviews (int) / data[].total_responses (int)
  • data[].avg_resp_time (float, days) / data[].avg_rating (float) / data[].response_rate (float, %)
  • current_page, last_page, per_page, total

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