Synup
Create a key
v1Resources/SEO/getGet the all-locations ranking roll-up

Get the all-locations ranking roll-up

Returns one summary row per location that has at least one ranking report, optionally scoped to a client and/or location tags. A key restricted to specific clients must pass clientId.

get/api/v1/seo/rollup
seo:read
Query parameters
clientIdstringoptional
Restrict results to one client. When your key is scoped to specific clients, this is required.
tagsstringoptional
Comma-separated location tag names. Only locations carrying at least one of these tags are included.
Response
dataobjectoptional
countnumberoptional
Number of rows returned.
rowsarray of objectoptional
One row per location with at least one ranking report.
idstringoptional
Unique identifier for the location.
locationNamestringoptional
The location's business name.
citystringoptional
City, or null.
avgRanknumberoptional
Mean average rank across the location's active keywords, or null.
top3Pctnumberoptional
Mean percent of grid points in the top 3 across the location's keywords, or null.
top10Pctnumberoptional
Mean percent of grid points in the top 10 across the location's keywords, or null.
bestKeywordobjectoptional
The location's best-ranking keyword, or null.
keywordstringoptional
avgRanknumberoptional
tagsarray of stringoptional
The location's internal tags.
Errors
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/seo/rollup
Your API key
clientId
tags
{
  "data": {
    "count": 2,
    "rows": [
      {
        "id": "cm_loc_1",
        "locationName": "Acme Dental — Downtown",
        "city": "Austin",
        "avgRank": 4.2,
        "top3Pct": 44,
        "top10Pct": 78,
        "bestKeyword": {
          "keyword": "dentist near me",
          "avgRank": 4.2
        },
        "tags": [
          "priority",
          "downtown"
        ]
      }
    ]
  }
}

Guides that use this endpoint