Synup
Create a key
v1Resources/Workspace/getGet workspace summary

Get workspace summary

Returns one aggregate snapshot of your whole agency: total clients, plus rolled-up location, review, and SEO stats.

get/api/v1/workspace/summary
workspace:read
Response
dataobjectoptional
clientsnumberoptional
Total number of clients in your agency.
locationsobjectoptional
Aggregate location stats across every client.
reviewsobjectoptional
Aggregate review stats across every client.
seoobjectoptional
Aggregate SEO ranking stats across every client.
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/workspace/summary
Your API key
{
  "data": {
    "clients": 24,
    "locations": {
      "total": 31,
      "byStatus": {
        "approved": 27,
        "archival_pending": 2,
        "pending": 2
      },
      "byVerification": {
        "verified": 22,
        "unverified": 6,
        "unknown": 3
      }
    },
    "reviews": {
      "avgRating": 4.4,
      "total": 1280
    },
    "seo": {
      "avgRank": 5.1,
      "top3Pct": 38
    }
  }
}

Guides that use this endpoint