Response report — by site

Overview

Returns review/response metrics grouped by review site (publisher) for the authenticated account — per-site review count, average rating, % of total, response count, response rate.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

POST /api/v1/reports/response/reviews/site

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Account tokens.

• Mounted 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.

• No account_id/client_* params on this account variant.

Rate limit

• No rate limit.

Request body

• Body:

{
  "range_start": "2024-01-01 00:00:00",
  "range_end": "2024-12-31 23:59:59",
  "store_id": 1
}

Response

• id (int) — review_site id
• review_site (string) — lowercased name (maps.google → google)
• review_site_logo (string|null) — S3 logo URL
• reviews_count (int) / avg_rating (float) — note this path returns reviews_count, not total_reviews
• response_rate_pct (float), avg_response_time (float), awaiting_response (int)
• per_of_total (float) — % of total reviews
• total_response (int) / per_total_response (float) — response rate %

200 OK · 200

{
  "data": [
    {
      "id": 44,
      "review_site": "google",
      "review_site_logo": "https://example.com/assets/google_ic.png",
      "reviews_count": 13,
      "avg_rating": 4.4,
      "per_of_total": 95.11,
      "total_response": 11,
      "per_total_response": 84.62,
      "response_rate_pct": 84.62,
      "avg_response_time": 1.4,
      "awaiting_response": 2
    }
  ]
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/response/reviews/site" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"range_start": "2024-01-01 00:00:00", "range_end": "2024-12-31 23:59:59", "store_id": 1}'