Response report — KPIs

Returns period-over-period KPI cards (review counts, ratings, response rate, average response time, awaiting-response, sentiment split) for the account-scoped response report.

Auth: Both — authentication; under the account-side reports/response group. Scope precedence: store_id (or client_location_id, then store), then single store; else account_id (or client_account_id, then account); else the auth user's own tree. An account user normally passes only store_id; a partner-context caller can pass account_id/client_account_id to scope to a child account. All id params guarded by an ownership check.

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
account_idintegernoa company under the auth company
client_account_idstringnoexternal account id; resolved to account_id
client_location_idstringnoexternal location id; resolved to store_id

Response{ data. } envelope.

  • reviews_current (int) / reviews_previous (int)
  • avg_rating (float) / avg_rating_previous (float)
  • response_rate_pct (float) / response_rate_pct_previous (float)
  • avg_response_time_in_days (string) — e.g. "1.2 Days"
  • awaiting_response (int)
  • reviews_sentiments (object) — negativeReviews, negativeReviews_percent, positiveReviews, positiveReviews_percent, neutralReviews, neutralReviews_percent

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