Synup
Create a key
v1Resources/Listings Published/getGet a listings summary

Get a listings summary

Publisher sync health across this client's (or the whole agency's) locations — an aggregate summary plus a per-location breakdown, insights (health %, sync distribution, weakest publishers, ranked "needs attention" items), and a deterministic headline. Scope to a subset with tags. Backed by the same rollup as the Listings → All locations view.

get/api/v1/listings/summary
listings:read
Query parameters
clientIdstringoptional
Limit to one client's locations.
tagsstringoptional
Comma-separated location tag names — only locations carrying at least one of these are included.
pageintegeroptional
Page of the per-location rows (1-based). Default 1.
perPageintegeroptional
Rows per page (max 200). Default 50.
Response
dataobjectoptional
summaryobjectoptional
Aggregate counts across every location in scope.
locationsnumberoptional
Number of locations in scope.
publishersTotalnumberoptional
Total publisher slots across all locations in scope.
publishersSyncednumberoptional
Of those, currently synced.
connectionIssuesnumberoptional
Native connector (Google/Facebook) rows with a connection problem.
duplicatesnumberoptional
Detected duplicate listings across the scope.
reviewsnumberoptional
Total reviews across the scope.
avgRatingnumberoptional
Average rating across locations that have one.
rowsarray of objectoptional
One row per location in scope (paginated).
locationIdstringoptional
Location id.
namestringoptional
Location name.
citystringoptional
Location city.
publishersnumberoptional
Publisher slots for this location.
syncednumberoptional
Of those, currently synced.
connectionIssuesnumberoptional
Native connector rows with a connection problem.
duplicatesnumberoptional
Detected duplicate listings for this location.
reviewsnumberoptional
Total reviews for this location.
unrepliednumberoptional
Reviews awaiting a reply.
avgRatingnumberoptional
Average rating for this location.
googleVerifiedbooleanoptional
Google listing is connected and verified.
googleConnectedbooleanoptional
Google is connected (may still be awaiting verification).
tagsarray of stringoptional
This location's internal tags.
insightsobjectoptional
Derived insights computed from the rows above.
healthnumberoptional
publishersSynced / publishersTotal, as a percentage.
distributionobjectoptional
Locations bucketed by sync rate (fullySynced 100%, healthy 90-99%, atRisk <90%).
fullySyncednumberoptional
Locations at 100% sync.
healthynumberoptional
Locations at 90-99% sync.
atRisknumberoptional
Locations below 90% sync.
weakestarray of objectoptional
Lowest-coverage publishers across the scope.
idstringoptional
Publisher id.
namestringoptional
Publisher name.
totalnumberoptional
Locations carrying this publisher.
syncednumberoptional
Of those, synced.
requiresActionnumberoptional
Of those, requiring action.
notConnectednumberoptional
Of those, not connected.
pctnumberoptional
Synced percentage, rounded.
directoriesarray of objectoptional
Full per-publisher coverage table.
idstringoptional
Publisher id.
namestringoptional
Publisher name.
totalnumberoptional
Locations carrying this publisher.
syncednumberoptional
Of those, synced.
requiresActionnumberoptional
Of those, requiring action.
notConnectednumberoptional
Of those, not connected.
pctnumberoptional
Synced percentage, rounded.
attentionarray of objectoptional
Ranked "needs attention" cards.
nnumberoptional
Count this card represents.
titlestringoptional
Card title.
substringoptional
Card subtitle.
tonestring (amber | blue | rose | zinc)optional
Visual tone for this card.
filterstring (issues | duplicates | under80 | unverified | notconnected)optional
Matching locations-table filter key.
headlinestringoptional
A deterministic one-line summary of scope health.
fixFirstarray of objectoptional
Ranked priority fixes.
textstringoptional
Fix description.
impactstring (High | Med | Low)optional
Estimated impact of this fix.
filterstring (issues | duplicates | under80 | unverified | notconnected)optional
Matching locations-table filter key.
totalnumberoptional
Total matching locations (for pagination), independent of perPage.
pagenumberoptional
Current page (1-based).
perPagenumberoptional
Rows per page.
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/listings/summary
Your API key
clientId
tags
page
perPage
{
  "data": {
    "summary": {
      "locations": 12,
      "publishersTotal": 96,
      "publishersSynced": 81,
      "connectionIssues": 3,
      "duplicates": 2,
      "reviews": 340,
      "avgRating": 4.6
    },
    "rows": [
      {
        "locationId": "loc_456",
        "name": "Acme Dental — Downtown",
        "city": "Austin",
        "publishers": 8,
        "synced": 7,
        "connectionIssues": 0,
        "duplicates": 0,
        "reviews": 26,
        "unreplied": 2,
        "avgRating": 4.8,
        "googleVerified": true,
        "googleConnected": true,
        "facebookConnected": true,
        "tags": [
          "vip"
        ]
      }
    ],
    "insights": {
      "health": 84,
      "distribution": {
        "fullySynced": 9,
        "healthy": 2,
        "atRisk": 1
      },
      "weakest": [
        {
          "locationId": "loc_789",
          "name": "Acme Dental — Eastside",
          "health": 40
        }
      ],
      "directories": [
        {
          "id": "google",
          "name": "Google Maps",
          "total": 12,
          "synced": 11,
          "requiresAction": 0,
          "notConnected": 1,
          "pct": 92
        }
      ],
      "attention": [
        {
          "n": 1,
          "title": "1 location under 90% synced",
          "sub": "Listings not fully propagated",
          "tone": "amber",
          "filter": "under80"
        }
      ],
      "headline": "84% listing health — 1 location under 90% synced needs attention.",
      "fixFirst": [
        {
          "text": "Reconnect 1 location's listing sync.",
          "impact": "Med"
        }
      ]
    },
    "total": 12,
    "page": 1,
    "perPage": 50
  }
}