post
https://production-api.shoutaboutus.com/api/v1/partner/report/review-response/by-location
Returns a paginated, per-location (per-store) review-response table for the partner — reviews, responses, average response time, average rating, and response rate per store.
Auth: Partner — authentication; under partner/report group. Handler hard-gates on company.bundle_id == 1. Store set precedence: store_id → single store; else account_id (account); else all partner stores. All id params guarded by an ownership check.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
| range_start | string | yes | Y-m-d H:i:s |
| range_end | string | yes | Y-m-d H:i:s |
| store_id | integer | no | belongs to auth company |
| account_id | integer | no | account (bundle_id=3) under this partner |
| client_location_id | string | no | resolved to store_id |
| client_account_id | string | no | resolved to account_id |
| sort_field | string | no | one of location_name,total_reviews,total_responses,avg_resp_time,avg_rating,response_rate (default location_name) |
| sort_by | string | no | asc/ASC/desc/DESC (default ASC) |
| search_field | string | no | only location_name |
| search_value | string | no | search term |
| limit | integer | no | per page (default 10) |
| page | integer | no | page number |
Response — paginated resource collection, data array + paginator meta.
data[].id(int) — store iddata[].location_name(string) —name - storeid(or the name alone)data[].total_reviews(int) /data[].total_responses(int)data[].avg_resp_time(float) — days (minutes/(24*60), rounded 2dp)data[].avg_rating(float) /data[].response_rate(float, percentage)current_page,last_page,per_page,total(paginator meta)
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…