post
https://production-api.shoutaboutus.com/api/v1/partner/report/review-response/by-site
Returns review/response metrics grouped by review site (publisher) for the partner — per-site review count, average rating, % of total, response count, and response rate.
Auth: Partner — authentication; under partner/report group. No explicit bundle gate in this handler, but all id params must sit inside your own account tree. Store set precedence: store_id → single store; else account_id (account); else all stores.
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 |
Response — { data: [.] } envelope; array of per-site rows.
id(int) — review_site idreview_site(string) — lowercased site name (maps.googlenormalized togoogle)review_site_logo(string|null) — S3 logo URLtotal_reviews(int) — reviews in range for this siteavg_rating(float) — average rating (hipages uses bridge)per_of_total(float) — % of all reviews from this sitetotal_response(int) — responses for this siteper_total_response(float) — response rate %
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…