Synupv1
Schlüssel erstellen
v1Ressourcen/Duplicate Listings

Duplicate Listings

Erkennen, Prüfen und Beheben doppelter Listings über Verzeichnisse hinweg.

Liefert für einen Standort erkannte doppelte Listings, gruppiert nach Publisher, mit Anzahlen je Status.

Doppelte Listings für einen Standort abrufen

get/api/v1/listings/duplicates
listings:read
Query-Parameter
locationIdstringerforderlich
Der abzurufende Standort. Erforderlich.
clientIdstringoptional
Der Kunde des Standorts. Nur zur Eindeutigkeit nötig, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist.
statusstring (potential | flagged | deleted | failed)optional
Ergebnisse auf einen Status beschränken: potential, flagged, deleted oder failed. Die Anzahlen werden unabhängig von diesem Filter immer für jeden Status zurückgegeben.
Antwort
dataobjectoptional
foundbooleanoptional
Ob der Standort gefunden und für diesen Schlüssel zugänglich war.
yourListingobjectoptional
Der eigene Name, die eigene Adresse und die eigene Telefonnummer dieses Standorts, zum Vergleich mit jeder Duplikat-Zeile. Fehlt, wenn found false ist.
namestringoptional
Der eigene Firmenname dieses Standorts.
addressstringoptional
Die eigene Adresse dieses Standorts.
phonestringoptional
Die eigene Telefonnummer dieses Standorts.
countsobjectoptional
Anzahl doppelter Listings für diesen Standort, je Status.
potentialnumberoptional
Anzahl der auf Prüfung wartenden Duplikate.
flaggednumberoptional
Anzahl der zur Entfernung markierten Duplikate.
deletednumberoptional
Anzahl der erfolgreich entfernten Duplikate.
failednumberoptional
Anzahl der Duplikate, deren Entfernungsversuch fehlgeschlagen ist.
groupsarray of objectoptional
Doppelte Listings, gruppiert nach Publisher.
publisherIdstringoptional
Kennung des Verzeichnisses/Publishers (dessen Site-URL).
publisherNamestringoptional
Anzeigename des Publishers.
originalUrlstringoptional
Live-URL des eigenen, echten Listings dieses Standorts bei diesem Publisher, oder null.
rowsarray of objectoptional
Die bei diesem Publisher gefundenen doppelten Listings.
idstringoptional
Eindeutige Kennung dieser Duplicate-Listing-Zeile.
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.
duplicateUrlstringoptional
Live-URL des doppelten Listings, oder null.
statusstring (potential | flagged | deleted | failed)optional
Einer von: potential, flagged, deleted, failed.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
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.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/listings/duplicates
Ihr API-Schlüssel
locationId *
clientId
status
{
  "data": {
    "found": true,
    "yourListing": {
      "name": "Acme Dental — Downtown",
      "address": "123 Main St, Austin, TX 78701",
      "phone": "+15125551234"
    },
    "counts": {
      "potential": 2,
      "flagged": 1,
      "deleted": 0,
      "failed": 0
    },
    "groups": [
      {
        "publisherId": "yelp",
        "publisherName": "Yelp",
        "status": "potential",
        "duplicates": [
          {
            "id": "dup_1",
            "name": "Acme Dental Downtown",
            "address": "123 Main St, Austin, TX",
            "phone": "+15125551234",
            "url": "https://yelp.com/biz/acme-dental-downtown",
            "matchScore": 0.92
          }
        ]
      }
    ]
  }
}
v1Ressourcen/Duplicate Listings/getDuplicate-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.

Duplicate-Listings-Rollup abrufen

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
    }
  }
}
v1Ressourcen/Duplicate Listings/postDoppelte Listings beheben

Markiert doppelte Listings zur Entfernung oder verwirft sie, entweder über eine explizite Liste von duplicateListingIds oder über einen Filter mit derselben Form wie die Rollup-Warteschlange. Der Filtermodus läuft als eine einzige Massenaktualisierung, beschränkt auf die Schnittmenge der eigenen Status des Filters und der zulässigen Ausgangsstatus der Aktion — er kann nie Zeilen außerhalb dessen erreichen, was dieser Filter anzeigen würde. Das Markieren entfernt das Listing selbst nicht; es reiht die Entfernungsanfrage ein, die ein Hintergrundjob beim Publisher ausführt.

Doppelte Listings beheben

post/api/v1/listings/duplicates/resolve
listings:write
Anfragetext
actionstring (flag | dismiss)erforderlich
flag (Entfernung beim Publisher beantragen) oder dismiss (als kein Duplikat markieren).
duplicateListingIdsarray of stringoptional
Explizite IDs zum Beheben, bis zu 1000. Schließt sich mit filter gegenseitig aus.
filterobjectoptional
Jede zutreffende Zeile, die diesem Filter entspricht, beheben, statt IDs explizit zu benennen. Ein auf bestimmte Kunden beschränkter Schlüssel muss im Filtermodus ebenfalls clientId übergeben.
filterstring (potential | flagged | deleted | failed)optional
Auf einen Status beschränken: potential, flagged, deleted oder failed.
bandstring (high | med | low)optional
Auf eine Konfidenzstufe beschränken: high, med oder low.
publisherSiteIdintegeroptional
Auf einen Publisher beschränken, über dessen numerische Site-ID.
locationIdstringoptional
Auf einen Standort beschränken.
searchstringoptional
Freitextsuche über Firmenname, Adresse und Telefonnummer.
clientIdstringoptional
Erforderlich, wenn Ihr Schlüssel auf bestimmte Kunden beschränkt ist und Sie den Filtermodus verwenden (der ID-Modus ist pro ID selbstbegrenzend und benötigt dies nicht).
Antwort
dataobjectoptional
updatednumberoptional
Anzahl der doppelten Listings, die in den neuen Status übergegangen sind.
skippedarray of stringoptional
Angeforderte IDs, die NICHT übergegangen sind — nicht gefunden, nicht im Besitz Ihrer Agentur/Ihres Kunden, oder nicht in einem zulässigen Ausgangsstatus. Im Filtermodus immer leer.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
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.
post/api/v1/listings/duplicates/resolve
Ihr API-Schlüssel
Anfragetext*
{
  "data": {
    "updated": 3,
    "skipped": []
  }
}