v1Ressources/Fiches en double/getObtenir la synthèse des fiches en double
Obtenir la synthèse des fiches en double
Renvoie une synthèse agrégée des fiches en double et une file paginée sur l'ensemble des établissements d'un client, ou de l'agence entière quand clientId est omis. Une clé limitée à des clients spécifiques doit toujours passer un clientId — il n'existe pas de valeur par défaut sûre au niveau agence pour cela.
get
listings:read/api/v1/listings/duplicates/rollupParamètres de requête
clientIdstringfacultatif
Restreint la synthèse à un client. Obligatoire quand votre clé est limitée à des clients spécifiques.
filterstring (potential | flagged | deleted | failed)facultatif
Restreint la file à un seul statut : potential, flagged, deleted ou failed.
bandstring (high | med | low)facultatif
Restreint la file à une seule tranche de confiance : high, med ou low.
publisherSiteIdintegerfacultatif
Restreint la file à un seul publisher, par son site id numérique (voir publisherSites dans la réponse).
locationIdstringfacultatif
Restreint la file à un seul établissement.
tagsstringfacultatif
Liste de tags d'établissement internes séparés par des virgules. Seuls les doublons sur des établissements portant au moins un de ces tags sont inclus.
searchstringfacultatif
Recherche en texte libre sur le nom commercial, l'adresse et le téléphone de la file.
sortstring (confidence | detected | lastSynced)facultatif
Ordre de tri de la file : confidence (score de correspondance le plus élevé en premier), detected (détecté le plus récemment en premier), ou lastSynced (vu le plus récemment en premier). Par défaut confidence.
pageintegerfacultatif
Numéro de page pour la file, à partir de 1. Par défaut 1.
perPageintegerfacultatif
Lignes par page pour la file, de 1 à 100. Par défaut 25.
Réponse
dataobjectfacultatif
summaryobjectfacultatif
Synthèse agrégée des fiches en double sur le périmètre demandé.
potentialTotalnumberfacultatif
Nombre total de doublons potentiels (non encore résolus) dans le périmètre.
locationsAffectednumberfacultatif
Nombre d'établissements distincts avec au moins un doublon potentiel.
bandsobjectfacultatif
Comptages de doublons potentiels ventilés par tranche de confiance.
highnumberfacultatif
Nombre de doublons potentiels avec un score de correspondance de confiance élevée.
mednumberfacultatif
Nombre de doublons potentiels avec un score de correspondance de confiance moyenne.
lownumberfacultatif
Nombre de doublons potentiels avec un score de correspondance de confiance faible ou non scoré.
topPublishersarray of objectfacultatif
Jusqu'à 5 publishers avec le plus de doublons potentiels, les pires contrevenants en premier.
publisherIdstringfacultatif
Identifiant de l'annuaire/publisher (son URL de site).
publisherNamestringfacultatif
Nom d'affichage du publisher.
countnumberfacultatif
Nombre de doublons potentiels sur ce publisher.
publisherSitesarray of objectfacultatif
Chaque publisher avec un doublon visible dans ce périmètre — la liste complète des options, contrairement à topPublishers qui est limitée à 5.
siteIdnumberfacultatif
Site id numérique pour ce publisher, utilisable comme filtre publisherSiteId de la synthèse ou de la résolution.
publisherIdstringfacultatif
Identifiant de l'annuaire/publisher (son URL de site).
publisherNamestringfacultatif
Nom d'affichage du publisher.
queueobjectfacultatif
La liste paginée et filtrable des lignes de doublons individuelles sur les établissements du périmètre.
rowsarray of objectfacultatif
Les lignes de doublons de la page actuelle.
idstringfacultatif
Identifiant unique de cette ligne de fiche en double.
locationIdstringfacultatif
ID de l'établissement auquel appartient ce doublon.
locationNamestringfacultatif
Nom de l'établissement auquel appartient ce doublon.
citystringfacultatif
Ville de l'établissement auquel appartient ce doublon, ou null.
locationStreetstringfacultatif
Adresse de rue de l'établissement auquel appartient ce doublon.
locationStatestringfacultatif
État ou région de l'établissement auquel appartient ce doublon.
locationPostalCodestringfacultatif
Code postal de l'établissement auquel appartient ce doublon.
publisherIdstringfacultatif
Identifiant de l'annuaire/publisher (son URL de site).
publisherNamestringfacultatif
Nom d'affichage du publisher.
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é.
bandstring (high | med | low)facultatif
Tranche de confiance pour le score de correspondance de cette ligne : high, med ou low.
statusstring (potential | flagged | deleted | failed)facultatif
L'une des valeurs : potential, flagged, deleted, failed.
duplicateUrlstringfacultatif
URL en ligne de la fiche en double, ou null.
originalUrlstringfacultatif
URL en ligne de la propre fiche réelle de cet établissement sur ce publisher, ou null.
detectedAtstringfacultatif
Date de première détection de ce doublon, au format horodatage ISO 8601.
lastSyncedAtstringfacultatif
Date de dernière observation de ce doublon lors d'une analyse, au format horodatage ISO 8601.
yourNamestringfacultatif
Le propre nom commercial de l'établissement propriétaire, pour comparaison.
yourAddressstringfacultatif
La propre adresse de l'établissement propriétaire, pour comparaison.
yourPhonestringfacultatif
Le propre numéro de téléphone de l'établissement propriétaire, pour comparaison.
tagsarray of stringfacultatif
Les tags internes de l'établissement propriétaire.
totalnumberfacultatif
Nombre total de lignes correspondant au filtre actuel, sur toutes les pages.
pagenumberfacultatif
Numéro de page actuel.
perPagenumberfacultatif
Lignes par page.
Erreurs
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.
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/rollup
Votre clé API
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
}
}
}