post
https://production-api.shoutaboutus.com/api/v1/partner/report/review-response/kpi
Returns period-over-period KPI cards (review counts, average ratings, response rate, average response time, awaiting-response backlog, sentiment split) for the partner's review-response report.
Auth: Partner — authentication; under partner/report group. Handler hard-gates on company.bundle_id == 1 (partner only). Store set resolves by precedence: store_id → single store; else account_id (a bundle_id=3 account); else all of the partner-user's stores. account_id/store_id/client_* are all validated by an ownership check so the partner can only reach its own tree.
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 | must belong to auth company; filters to one store |
| account_id | integer | no | an account (company.bundle_id=3) under this partner |
| client_location_id | string | no | external location id; resolved to a store_id |
| client_account_id | string | no | external account id; resolved to an account_id |
Response — { data. } envelope.
reviews_current(int) — reviews in rangereviews_previous(int) — reviews in equivalent prior periodavg_rating(float) /avg_rating_previous(float)response_rate_pct(float) /response_rate_pct_previous(float) — responded/total × 100avg_response_time_in_days(string) — e.g."1.5 Days"awaiting_response(int) — plan-aware backlog countreviews_sentiments(object) —positive/neutral/negativecounts
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…