Synup
Create a key
v1Resources/Clients/getGet client summary

Get client summary

Returns a rolled-up snapshot for one client: aggregate location, review, and SEO stats.

get/api/v1/clients/summary
clients:read
Query parameters
clientIdstringrequired
The client to summarize.
Response
dataobjectoptional
locationsobjectoptional
Aggregate location stats for this client.
reviewsobjectoptional
Aggregate review stats for this client.
seoobjectoptional
Aggregate SEO ranking stats for this client.
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/clients/summary
Your API key
clientId *
{
  "data": {
    "locations": {
      "total": 1,
      "byStatus": {
        "approved": 1
      },
      "byVerification": {
        "unknown": 1
      }
    },
    "reviews": {
      "avgRating": 4.8,
      "total": 26
    },
    "seo": {
      "avgRank": 3.2,
      "top3Pct": 0.62
    }
  }
}

Guides that use this endpoint