Reviews by publisher (account-scoped)

Overview

Returns per-publisher lifetime totals (all-time count + overall rating from the synced pivot, hipages spans all connected sites) plus the selected-period review count and rating. Results are scoped to the authenticated account.

Prerequisites

• A bearer token. Callable with Account tokens.

Base URL

Endpoint

POST /api/v1/reports/response/reviews/publisher

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 — for partner-wide scope use partner/report/review-response/by-publisher.

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) — display name (maps.google → Google)
• review_site_logo (string) — S3 logo URL
• review_site_color (string|null)
• total_reviews (int) — lifetime total
• overall_rating (float|null) — count-weighted lifetime rating
• period_reviews (int) — reviews within the range
• period_rating (float|null) — average rating within range

200 OK · 200

{
  "data": [
    {
      "id": 44,
      "review_site": "Google",
      "review_site_logo": "https://s3.amazonaws.com/bucket/assets/review-sites/google_ic.png",
      "review_site_color": "#4285F4",
      "total_reviews": 1320,
      "overall_rating": 4.4,
      "period_reviews": 28,
      "period_rating": 4.7
    }
  ]
}

422 Validation error · 422

{
  "message": "The range start does not match the format Y-m-d H:i:s.",
  "errors": {
    "range_start": ["The range start does not match the format Y-m-d H:i:s."]
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/reports/response/reviews/publisher" \
  --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}'