GET/api/v4/locations/listings/duplicates

Obtenir toutes les fiches en double d'un compte

Renvoie une synthèse paginée, à l'échelle du compte, des fiches potentiellement en double pour tous les établissements du compte.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chaîne de requête

NomTypeObligatoireDescriptionPar défaut
statusstringfacultatifDuplicate status to return: `POTENTIAL`, `PROCESSING`, `FIXED`, or `FAILED`. Case-insensitive.POTENTIAL
siteIdintegerfacultatifNarrow to a single publisher by site ID. See the plan-sites endpoint for valid IDs.—
tagstringfacultatifTag to scope the rollup to. Defaults to every location the key can see.all
pageintegerfacultatif1-based page number.1
perPageintegerfacultatifRecords per page.—

Réponses

200Paginated rollup of duplicate listing records across the account.
Response
{  "data": {    "duplicateListingsRollup": {      "pageInfo": {        "hasNextPage": true,        "hasPreviousPage": false,        "totalPages": 34,        "totalRecords": 1673      },      "records": [        {          "id": "3329229",          "name": "Woodbury Train Station",          "nameValid": false,          "duplicateProcessingState": "POTENTIAL",          "liveLink": "http://citysquares.com/b/woodbury-train-station-23598450",          "locationId": "73451",          "siteName": "City Squares",          "siteUrl": "citysquares.com"        }      ]    }  }}
400An invalid `status` value, e.g. one outside `POTENTIAL` / `PROCESSING` / `FIXED` / `FAILED`.
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Renvoie une vue à l'échelle du compte des fiches potentiellement en double dans tous les annuaires des plateformes de publication, regroupées pour vous permettre de trier les doublons en masse au lieu d'interroger chaque établissement un par un. La structure pageInfo/records présentée ci-dessus a été vérifiée en conditions réelles sur le compte 12345 ; ce compte ne comporte actuellement aucun doublon ouvert, de sorte que l'unique enregistrement est représentatif de la structure renvoyée pour un établissement présentant des doublons.

Cas d'utilisation : traitement nocturne de suppression des doublons

Parcourez les pages de doublons POTENTIAL pour l'ensemble du compte et transmettez chaque id à une personne chargée de l'examiner :

Code
GET /api/v4/locations/listings/duplicates?status=POTENTIAL&page=1

Les filtres sont des paramètres de requête à plat, et non du JSON. status et siteId sont tous deux facultatifs. Si aucun des deux n'est fourni, status a pour valeur par défaut POTENTIAL et tag a pour valeur par défaut all, de sorte qu'un simple GET /api/v4/locations/listings/duplicates renvoie les doublons ouverts du compte plutôt qu'un 400. Parcourez les pages à l'aide de pageInfo.hasNextPage en incrémentant page jusqu'à ce que sa valeur soit false ; totalRecords et totalPages vous permettent d'afficher la progression.

Cas d'utilisation : limiter le périmètre à un segment de votre catalogue

La synthèse couvre toujours tous les établissements auxquels la clé donne accès. Pour examiner un sous-ensemble, parcourez les pages du résultat et regroupez les enregistrements selon leur locationId, ou appelez le point de terminaison par établissement pour les établissements qui vous intéressent.

Une fois que vous disposez de id à traiter, résolvez-les avec Marquer une fiche comme doublon ou écartez les faux positifs avec Marquer une fiche comme n'étant pas un doublon. Pour obtenir les doublons d'un seul établissement regroupés par site, utilisez Obtenir les fiches en double d'un établissement. Ce point de terminaison renvoie une liste paginée et est soumis à la limite de débit du compte ; en cas de 429, espacez les requêtes en vous appuyant sur l'en-tête Retry-After.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/listings/duplicates' \  -H "Authorization: API $LISTINGSAPI_KEY"