Synupv1
Create a key
v1Resources/SEO/getGet a location's competitor leaderboard

Get a location's competitor leaderboard

Returns the businesses that dominate this location's ranking grid for its most recently tracked keyword, ranked by how much of the grid they occupy in the top 3. Includes your own business (isYou) for comparison, and tags entries already in your tracked-competitor registry with their registry ID.

get/api/v1/seo/competitors
seo:read
Query parameters
locationIdstringrequired
The location to look up.
clientIdstringoptional
The location's client.
Response
dataobjectoptional
countnumberoptional
Number of competitors returned.
competitorsarray of objectoptional
The competitor leaderboard, including your own business.
idstringoptional
An identifier for this business (its place ID, or a derived key when no place ID is available).
competitorIdstringoptional
ID in your tracked-competitor registry, present only when this business is already tracked there.
namestringoptional
Business name.
isYoubooleanoptional
Whether this row is your own business.
ratingnumberoptional
Star rating, or null.
reviewCountnumberoptional
Number of reviews, or null.
avgRanknumberoptional
Average rank across the grid points this business appeared at, or null.
top3Pctnumberoptional
Percent of grid points where this business ranks in the top 3, averaged across all tracked keywords.
gridPointsnumberoptional
Number of grid points this business appeared at.
categorystringoptional
Business category, or null.
websitestringoptional
Business website, or null (not returned by the local-search data source).
keywordBreakdownarray of objectoptional
This business's top-3 coverage broken out per tracked keyword.
keywordstringoptional
The tracked keyword.
top3Pctnumberoptional
Percent of that keyword's grid points where this business ranks in the top 3.
featureComparisonarray of objectoptional
Feature-by-feature comparison rows against your business, if any.
featurestringoptional
competitorbooleanoptional
youbooleanoptional
hoursComparisonarray of objectoptional
Business-hours comparison rows against your business, if any.
daystringoptional
competitorstringoptional
youstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
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/competitors
Your API key
locationId *
clientId
{
  "data": {
    "count": 2,
    "competitors": [
      {
        "id": "cm_comp_1",
        "competitorId": "cm_competitor_1",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "rating": 4.6,
        "reviewCount": 210,
        "avgRank": 4.2,
        "top3Pct": 44,
        "gridPoints": 25,
        "category": "Dentist",
        "website": "https://acmedental.example.com",
        "keywordBreakdown": [
          {
            "keyword": "dentist near me",
            "top3Pct": 60
          }
        ],
        "featureComparison": [
          {
            "feature": "Online booking",
            "competitor": false,
            "you": true
          }
        ],
        "hoursComparison": [
          {
            "day": "Monday",
            "competitor": "9am–5pm",
            "you": "8am–6pm"
          }
        ]
      }
    ]
  }
}