Skip to content
SynupAPI
Get an API key
EVENTreview_analytics.weekly_snapshot

Weekly review analytics snapshot

Event name: review_analytics.weekly_snapshot

The weekly review-analytics roll-up for a location. Scope: location-scoped. Delivered as a signed HTTP POST to your Webhooks URL.

Every delivery is signed. Verify X-Synup-Signature before processing — see Synup Webhooks.

Payload

NameTypeRequiredDescription
eventstringoptionalDotted event name.
timestampstringoptionalISO-8601 UTC time the event was emitted.
account_idintegeroptionalSynup account the event belongs to.
location_idstringoptionalNumeric string for location-scoped events; null for brand-scoped events.
dataobjectoptional
data.periodstringoptionalPeriod start, YYYY-MM-DD.
data.granularitystringoptional"daily" or "weekly".
data.total_reviewsintegeroptionalAll-time total review count for the location.
data.new_reviews_in_periodintegeroptionalNew reviews received during this period.
data.average_ratingnumberoptionalAverage star rating this period (4-dp float; 0.0 if none).
data.previous_average_ratingnumberoptionalAverage rating for the preceding period.
Example delivery
{
  "event": "review_analytics.weekly_snapshot",
  "timestamp": "2026-07-13T02:00:00Z",
  "account_id": 11073,
  "location_id": "279381",
  "data": {
    "period": "2026-07-06",
    "granularity": "weekly",
    "total_reviews": 1240,
    "new_reviews_in_period": 18,
    "average_rating": 4.6123,
    "previous_average_rating": 4.5901
  }
}