v1Resources/Listings Published/getGet listing issues

Get listing issues

The issues shown on the Listings Overview, as data. Each issue is one fix (an edit, a sign-in or a step outside the app) and lists the publisher listings that fix would unblock. With locationId, returns that location's issues in full. Without it, returns a roll-up across your key's locations, optionally narrowed to one client and one tag, read in pages of locations: repeat the call with cursor set to page.nextCursor and the same other parameters until page.nextCursor is null. Read-only.

get/api/v1/listings/issues
listings:read
Query parameters
locationIdstringoptional
Read one location's issues, by its id or public loc_ id. Omit for a roll-up across locations.
clientIdstringoptional
Limit the read to one client's locations.
tagstringoptional
Limit the roll-up to locations carrying this tag name. Ignored when locationId is set.
problemstringoptional
Comma-separated problem keys to include, for example phone,hours. An unknown key returns 400 with code invalid_problem.
familystringoptional
Comma-separated issue families to include: access, identity, hours, content, media, map or other. An unknown family returns 400 with code invalid_family.
qstringoptional
Search the roll-up by location name, case-insensitive, up to 100 characters.
cursorstringoptional
The page.nextCursor from the previous response, to continue a roll-up. Send it with the same other parameters: a cursor issued for a different scope or filter returns 400 with code cursor_scope_mismatch.
Response
dataobjectoptional
scopeobjectrequired
kindstring (location | rollup)optional
keystringoptional
clientIdstringoptional
tagstringoptional
locationIdstringoptional
requestedLocationIdstringoptional
filtersobjectoptional
problemsarray of stringoptional
familiesarray of stringoptional
qstringoptional
generatedAtstringrequired
completebooleanrequired
True only when this one response covered every location in scope. Then totals is exact; otherwise totals is null.
totalsobjectrequired
fixesintegerrequired
Distinct fixes. One shared-account reconnect counts once, however many locations it covers.
affectedListingsintegerrequired
locationsWithIssuesintegerrequired
pageCountsobjectrequired
fixesintegerrequired
Distinct fixes. One shared-account reconnect counts once, however many locations it covers.
affectedListingsintegerrequired
locationsWithIssuesintegerrequired
pageobjectrequired
scopeLocationsintegeroptional
scannedLocationsintegeroptional
previouslyScannedintegeroptional
nextCursorstringoptional
Pass this as cursor, with the same other parameters, to read the next page of locations. Null when there are no more pages.
lastPagebooleanoptional
noticestring (archived | not_a_listing_location)required
issuesarray of objectrequired
idstringrequired
fixKeystringrequired
groupKeystringrequired
locationIdstringrequired
locationPublicIdstringoptional
locationNamestringoptional
locationCitystringoptional
clientIdstringoptional
clientNamestringoptional
problemstringrequired
What is wrong, as a stable problem key, for example phone or reconnect_google.
familystring (access | identity | hours | content | media | map | other)required
tierinteger (1 | 2 | 3)required
statestring (open | update_in_flight | update_saved)required
reasonKeystringoptional
fixobjectrequired
The action that clears this issue. kind says which: edit (a field in the location editor), connect, account (renew the same account), verify (on Google), external (a step on another site) or explain (no in-app fix).
kindstring (edit | connect | account | verify | external | explain)required
sectionstring (identity | hours | description | social | media | businessDetails | openStatus | actionLinks | serviceArea | services | attributes | relationships | pin)optional
fieldstring (name | address | phone | website | primaryCategory | publisherCategory | hours | openingDate | openStatus | description | socialLinks | menuUrl | photos | serviceArea | services | attributes | relationships | coordinates)optional
tabstring (master | google | facebook | apple | bing)optional
providerstring (google | facebook | apple)optional
flowstring (renew)optional
accountobjectoptional
launchobjectoptional
targetobjectoptional
nextstring (contact_support | review_details | no_in_app_fix)optional
capabilityobjectrequired
allowedbooleanrequired
reasonstring (write_not_permitted | portal_not_permitted | field_not_portal_editable | clients_module_denied | agency_credential_requires_unrestricted_member | credential_serves_other_clients | account_unresolved | missing_api_scope)required
alternativesarray of objectoptional
fixobjectoptional
The action that clears this issue. kind says which: edit (a field in the location editor), connect, account (renew the same account), verify (on Google), external (a step on another site) or explain (no in-app fix).
capabilityobjectoptional
publishersarray of objectrequired
publisherIdstringoptional
publisherNamestringoptional
siteIdintegeroptional
affectedListingsintegerrequired
evidenceAtstringoptional
groupsarray of objectrequired
groupKeystringoptional
problemstringoptional
familystringoptional
tierintegeroptional
accountobjectoptional
keystringrequired
An opaque, stable key for the account's credential. Group by this, never by the label.
labelstringrequired
agencyManagedbooleanrequired
locationsarray of objectoptional
locationIdstringoptional
locationPublicIdstringoptional
locationNamestringoptional
locationCitystringoptional
clientIdstringoptional
clientNamestringoptional
issueIdstringoptional
problemstringoptional
statestring (open | update_in_flight | update_saved)optional
affectedListingsintegeroptional
fixesintegeroptional
affectedListingsintegeroptional
affectedLocationsintegeroptional
Errors
400The query is invalid. code says why: invalid_cursor, cursor_scope_mismatch, invalid_problem, invalid_family or search_too_long.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/listings/issues
Your API key
locationId
clientId
tag
problem
family
q
cursor
{}

Guides that use this resource