Synup
Create a key
v1Resources/Listings Published/getGet Citation Index

Get Citation Index

How many directories index this location, current vs. a prior period.

get/api/v1/seo/citation-index
seo:read
Query parameters
locationIdstringrequired
The location to look up. Look it up with GET /api/v1/locations.
clientIdstringoptional
The location's client. Only needed to disambiguate when your key is scoped to specific clients.
fromstringoptional
Window start (ISO date). Defaults to 30 days ago.
tostringoptional
Window end (ISO date). Defaults to now.
Response
dataobjectoptional
availablebooleanoptional
Whether a citation-index snapshot exists yet for this location.
currentobjectoptional
The latest snapshot at or before the window end.
percentagenumberoptional
Percentage of listings currently indexed (0–100), or null.
listingsnumberoptional
Total live listings counted in this snapshot, or null.
indexednumberoptional
Of those, how many are indexed, or null.
weekStartstringoptional
The snapshot's week, as Monday 00:00 UTC.
recordedAtstringoptional
When this snapshot was last written.
previousobjectoptional
The latest snapshot at or before the window start, for comparison.
percentagenumberoptional
Percentage of listings currently indexed (0–100), or null.
listingsnumberoptional
Total live listings counted in this snapshot, or null.
indexednumberoptional
Of those, how many are indexed, or null.
weekStartstringoptional
The snapshot's week, as Monday 00:00 UTC.
recordedAtstringoptional
When this snapshot was last written.
inventoryobjectoptional
Today's live listing pages for this location, each with its last recorded result. Not comparable with the weekly snapshots in current and previous.
basisstring (current_inventory)required
Always current_inventory: these are today's pages, not a past snapshot.
pagesarray of objectrequired
One entry per live listing page.
idstringrequired
The listing's id.
publisherIdstringrequired
The publisher's id.
namestringrequired
The publisher's name.
urlstringrequired
The live listing page's URL. Null when the stored link isn't an absolute http(s) URL.
statusstring (indexed | not_indexed | pending | not_checked)required
The last recorded result, not a live check: indexed, not_indexed, pending or not_checked. pending and not_checked are unknown, never a negative.
checkedAtstringrequired
When the last check was recorded, or null.
indexedAtstringrequired
When the page was confirmed indexed, or null. A page confirmed indexed isn't checked again.
countsobjectrequired
The pages, counted by status.
totalintegerrequired
Live listing pages.
indexedintegerrequired
Pages shown in Google Search.
notIndexedintegerrequired
Pages with a recorded result of not indexed.
pendingintegerrequired
Pages awaiting a result. Unknown, never a negative.
notCheckedintegerrequired
Pages with no usable result yet. Unknown, never a negative.
latestEvidenceAtstringrequired
When the newest check or confirmation across the pages was recorded, or null. Can be a confirmation date with no new check behind it.
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/citation-index
Your API key
locationId *
clientId
from
to
{
  "data": {
    "available": true,
    "current": {
      "percentage": 90.48,
      "listings": 42,
      "indexed": 38
    },
    "previous": {
      "percentage": 83.33,
      "listings": 42,
      "indexed": 35
    }
  }
}

Guides that use this endpoint