Synupv1
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.
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.
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
    }
  }
}