v1Ressources/Fiches en double/getObtenir les fiches en double d'un établissement
Obtenir les fiches en double d'un établissement
Renvoie les fiches en double détectées pour un établissement, regroupées par publisher, avec des comptages par statut.
get
listings:read/api/v1/listings/duplicatesParamètres de requête
locationIdstringobligatoire
L'établissement à consulter. Obligatoire.
clientIdstringfacultatif
Le client de l'établissement. Nécessaire seulement pour lever une ambiguïté quand votre clé est limitée à des clients spécifiques.
statusstring (potential | flagged | deleted | failed)facultatif
Restreint les résultats à un seul statut : potential, flagged, deleted ou failed. Les comptages sont toujours renvoyés pour chaque statut, quel que soit ce filtre.
Réponse
dataobjectfacultatif
foundbooleanfacultatif
Si l'établissement a été trouvé et était accessible à cette clé.
yourListingobjectfacultatif
Le propre nom, adresse et téléphone de cet établissement, pour comparaison avec chaque ligne en double. Absent quand found vaut false.
namestringfacultatif
Le propre nom commercial de cet établissement.
addressstringfacultatif
La propre adresse de cet établissement.
phonestringfacultatif
Le propre numéro de téléphone de cet établissement.
countsobjectfacultatif
Comptages des fiches en double pour cet établissement, par statut.
potentialnumberfacultatif
Nombre de doublons en attente d'examen.
flaggednumberfacultatif
Nombre de doublons marqués pour suppression.
deletednumberfacultatif
Nombre de doublons supprimés avec succès.
failednumberfacultatif
Nombre de doublons dont la tentative de suppression a échoué.
groupsarray of objectfacultatif
Fiches en double, regroupées par publisher.
publisherIdstringfacultatif
Identifiant de l'annuaire/publisher (son URL de site).
publisherNamestringfacultatif
Nom d'affichage du publisher.
originalUrlstringfacultatif
URL en ligne de la propre fiche réelle de cet établissement sur ce publisher, ou null.
rowsarray of objectfacultatif
Les fiches en double trouvées sur ce publisher.
idstringfacultatif
Identifiant unique de cette ligne de fiche en double.
businessNamestringfacultatif
Nom commercial tel qu'il apparaît sur la fiche en double.
businessNameMatchesbooleanfacultatif
Si le nom commercial du doublon correspond au propre nom de cet établissement.
addressstringfacultatif
Rue, ville et code postal de la fiche en double, joints en une seule chaîne.
addressMatchesbooleanfacultatif
Si l'adresse du doublon correspond à la propre adresse de cet établissement.
phonestringfacultatif
Numéro de téléphone tel qu'il apparaît sur la fiche en double.
phoneMatchesbooleanfacultatif
Si le numéro de téléphone du doublon correspond au propre numéro de téléphone de cet établissement.
matchScorenumberfacultatif
Confiance du modèle, de 0 à 1, qu'il s'agit de la même entreprise que la fiche réelle, ou null si non scoré.
duplicateUrlstringfacultatif
URL en ligne de la fiche en double, ou null.
statusstring (potential | flagged | deleted | failed)facultatif
L'une des valeurs : potential, flagged, deleted, failed.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/listings/duplicates
Votre clé API
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
}
]
}
]
}
}