Skip to content
SynupAPI
Get an API key
EVENTrankings.gridrank_report_ready

Grid rank report ready

Event name: rankings.gridrank_report_ready

A Grid (local-rank map) report finished generating. 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.report_idstringoptionalReport UUID.
data.enginestringoptionalGrid vendor: "GEORANKER", "LOCALFALCON", or "AWS".
data.snapshot_datestringoptionalCompletion date, YYYY-MM-DD.
data.geoobjectoptionalGrid geometry: latitude, longitude, grid_size, grid_distance, grid_distance_unit.
data.average_ranknumberoptionalAverage rank across all grid points.
data.top_one_sharenumberoptionalShare of points ranked #1.
data.top_two_sharenumberoptionalShare of points ranked in the top two.
Example delivery
{
  "event": "rankings.gridrank_report_ready",
  "timestamp": "2026-07-15T05:02:00Z",
  "account_id": 11073,
  "location_id": "279381",
  "data": {
    "report_id": "d4f1a2b3-1111-4c22-9d33-5e6f7a8b9c0d",
    "engine": "LOCALFALCON",
    "snapshot_date": "2026-07-15",
    "geo": {
      "latitude": 37.7749,
      "longitude": -122.4194,
      "grid_size": 7,
      "grid_distance": 1,
      "grid_distance_unit": "km"
    },
    "average_rank": 4.2,
    "top_one_share": 0.18,
    "top_two_share": 0.35
  }
}