Synupv1
Schlüssel erstellen
v1Ressourcen/Duplicate Listings/getDuplicate-Listings-Rollup abrufen

Duplicate-Listings-Rollup abrufen

Liefert eine aggregierte Zusammenfassung doppelter Listings und eine paginierte Warteschlange über alle Standorte eines Kunden, oder die gesamte Agentur, wenn clientId weggelassen wird. Ein auf bestimmte Kunden beschränkter Schlüssel muss immer eine clientId übergeben — es gibt dafür keinen sicheren agenturweiten Standardwert.

get/api/v1/listings/duplicates/rollup
listings:read
Query-Parameter
clientIdstringoptional
Das Rollup auf einen Kunden beschränken. Erforderlich, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
filterstring (potential | flagged | deleted | failed)optional
Die Warteschlange auf einen Status beschränken: potential, flagged, deleted oder failed.
bandstring (high | med | low)optional
Die Warteschlange auf eine Konfidenzstufe beschränken: high, med oder low.
publisherSiteIdintegeroptional
Die Warteschlange auf einen Publisher beschränken, über dessen numerische Site-ID (siehe publisherSites in der Antwort).
locationIdstringoptional
Die Warteschlange auf einen Standort beschränken.
tagsstringoptional
Kommagetrennte Liste interner Standort-Tags. Nur Duplikate an Standorten mit mindestens einem dieser Tags werden einbezogen.
searchstringoptional
Freitextsuche über Firmenname, Adresse und Telefonnummer der Warteschlange.
sortstring (confidence | detected | lastSynced)optional
Sortierreihenfolge der Warteschlange: confidence (höchster Übereinstimmungswert zuerst), detected (zuletzt erkannte zuerst) oder lastSynced (zuletzt gesehene zuerst). Standardmäßig confidence.
pageintegeroptional
Seitenzahl für die Warteschlange, beginnend bei 1. Standardmäßig 1.
perPageintegeroptional
Zeilen pro Seite für die Warteschlange, 1–100. Standardmäßig 25.
Antwort
dataobjectoptional
summaryobjectoptional
Aggregierte Zusammenfassung doppelter Listings über den angeforderten Geltungsbereich.
potentialTotalnumberoptional
Gesamtzahl der potenziellen (noch nicht behobenen) Duplikate im Geltungsbereich.
locationsAffectednumberoptional
Anzahl der unterschiedlichen Standorte mit mindestens einem potenziellen Duplikat.
bandsobjectoptional
Anzahl potenzieller Duplikate, aufgeschlüsselt nach Konfidenzstufe.
highnumberoptional
Anzahl potenzieller Duplikate mit hoher Übereinstimmungs-Konfidenz.
mednumberoptional
Anzahl potenzieller Duplikate mit mittlerer Übereinstimmungs-Konfidenz.
lownumberoptional
Anzahl potenzieller Duplikate mit niedriger oder unbewerteter Übereinstimmungs-Konfidenz.
topPublishersarray of objectoptional
Bis zu 5 Publisher mit den meisten potenziellen Duplikaten, größte Übeltäter zuerst.
publisherIdstringoptional
Kennung des Verzeichnisses/Publishers (dessen Site-URL).
publisherNamestringoptional
Anzeigename des Publishers.
countnumberoptional
Anzahl potenzieller Duplikate bei diesem Publisher.
publisherSitesarray of objectoptional
Jeder Publisher mit einem sichtbaren Duplikat in diesem Geltungsbereich — die vollständige Optionsliste, im Gegensatz zu topPublishers, das auf 5 begrenzt ist.
siteIdnumberoptional
Numerische Site-ID für diesen Publisher, verwendbar als publisherSiteId-Filter für das Rollup oder für resolve.
publisherIdstringoptional
Kennung des Verzeichnisses/Publishers (dessen Site-URL).
publisherNamestringoptional
Anzeigename des Publishers.
queueobjectoptional
Die paginierte, filterbare Liste einzelner Duplikat-Zeilen über die Standorte des Geltungsbereichs.
rowsarray of objectoptional
Die Duplikat-Zeilen auf der aktuellen Seite.
idstringoptional
Eindeutige Kennung dieser Duplicate-Listing-Zeile.
locationIdstringoptional
ID des Standorts, zu dem dieses Duplikat gehört.
locationNamestringoptional
Name des Standorts, zu dem dieses Duplikat gehört.
citystringoptional
Stadt des Standorts, zu dem dieses Duplikat gehört, oder null.
locationStreetstringoptional
Straßenadresse des Standorts, zu dem dieses Duplikat gehört.
locationStatestringoptional
Bundesland oder Region des Standorts, zu dem dieses Duplikat gehört.
locationPostalCodestringoptional
Postleitzahl des Standorts, zu dem dieses Duplikat gehört.
publisherIdstringoptional
Kennung des Verzeichnisses/Publishers (dessen Site-URL).
publisherNamestringoptional
Anzeigename des Publishers.
businessNamestringoptional
Firmenname, wie er auf dem doppelten Listing erscheint.
businessNameMatchesbooleanoptional
Ob der Firmenname des Duplikats mit dem eigenen Namen dieses Standorts übereinstimmt.
addressstringoptional
Straße, Stadt und Postleitzahl des doppelten Listings, zu einer Zeichenfolge zusammengefügt.
addressMatchesbooleanoptional
Ob die Adresse des Duplikats mit der eigenen Adresse dieses Standorts übereinstimmt.
phonestringoptional
Telefonnummer, wie sie auf dem doppelten Listing erscheint.
phoneMatchesbooleanoptional
Ob die Telefonnummer des Duplikats mit der eigenen Telefonnummer dieses Standorts übereinstimmt.
matchScorenumberoptional
Modellvertrauen, 0–1, dass es sich um dasselbe Unternehmen wie beim echten Listing handelt, oder null, falls nicht bewertet.
bandstring (high | med | low)optional
Konfidenzstufe für den Übereinstimmungswert dieser Zeile: high, med oder low.
statusstring (potential | flagged | deleted | failed)optional
Einer von: potential, flagged, deleted, failed.
duplicateUrlstringoptional
Live-URL des doppelten Listings, oder null.
originalUrlstringoptional
Live-URL des eigenen, echten Listings dieses Standorts bei diesem Publisher, oder null.
detectedAtstringoptional
Wann dieses Duplikat erstmals erkannt wurde, als ISO-8601-Zeitstempel.
lastSyncedAtstringoptional
Wann dieses Duplikat zuletzt bei einem Scan gesehen wurde, als ISO-8601-Zeitstempel.
yourNamestringoptional
Der eigene Firmenname des zugehörigen Standorts, zum Vergleich.
yourAddressstringoptional
Die eigene Adresse des zugehörigen Standorts, zum Vergleich.
yourPhonestringoptional
Die eigene Telefonnummer des zugehörigen Standorts, zum Vergleich.
tagsarray of stringoptional
Die internen Tags des zugehörigen Standorts.
totalnumberoptional
Gesamtzahl der zum aktuellen Filter passenden Zeilen, über alle Seiten.
pagenumberoptional
Aktuelle Seitenzahl.
perPagenumberoptional
Zeilen pro Seite.
Fehler
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/listings/duplicates/rollup
Ihr API-Schlüssel
clientId
filter
band
publisherSiteId
locationId
tags
search
sort
page
perPage
{
  "data": {
    "summary": {
      "potentialTotal": 14,
      "locationsAffected": 6,
      "bands": {
        "high": 4,
        "med": 7,
        "low": 3
      },
      "topPublishers": [
        {
          "publisherId": "yelp",
          "publisherName": "Yelp",
          "count": 6
        }
      ],
      "publisherSites": [
        {
          "id": "yelp",
          "name": "Yelp"
        }
      ]
    },
    "queue": {
      "rows": [
        {
          "id": "dup_1",
          "locationId": "loc_456",
          "locationName": "Acme Dental — Downtown",
          "publisherId": "yelp",
          "publisherName": "Yelp",
          "name": "Acme Dental Downtown",
          "matchScore": 0.92,
          "status": "potential"
        }
      ],
      "total": 14,
      "page": 1,
      "perPage": 25
    }
  }
}