Synup
Créer une clé
v1Ressources/Fiches publiées/getObtenir un résumé des fiches

Obtenir un résumé des fiches

État de synchronisation des publishers sur les emplacements de ce client (ou de toute l'agence) — un résumé agrégé ainsi qu'une répartition par emplacement, des insights (% de santé, répartition de synchronisation, publishers les plus faibles, éléments « à traiter » classés) et un titre déterministe. Restreindre à un sous-ensemble avec tags. Utilise le même rollup que la vue Fiches → Tous les emplacements.

get/api/v1/listings/summary
listings:read
Paramètres de requête
clientIdstringfacultatif
Limiter aux emplacements d'un client.
tagsstringfacultatif
Noms de tags d'emplacement séparés par des virgules — seuls les emplacements portant au moins un de ces tags sont inclus.
pageintegerfacultatif
Page des lignes par emplacement (base 1). Par défaut 1.
perPageintegerfacultatif
Lignes par page (max 200). Par défaut 50.
withVisibilitybooleanfacultatif
Mettez true pour ajouter les résultats citation et maps de chaque ligne ainsi que les totaux visibility. Désactivé par défaut.
Réponse
dataobjectfacultatif
summaryobjectfacultatif
Totaux agrégés sur tous les emplacements du périmètre.
locationsnumberfacultatif
Nombre d'emplacements dans le périmètre.
publishersTotalnumberfacultatif
Total des emplacements publisher sur tous les emplacements du périmètre.
publishersSyncednumberfacultatif
Parmi eux, actuellement synchronisés.
connectionIssuesnumberfacultatif
Lignes de connecteurs natifs (Google/Facebook) avec un problème de connexion.
duplicatesnumberfacultatif
Fiches en double détectées dans le périmètre.
reviewsnumberfacultatif
Total des avis dans le périmètre.
avgRatingnumberfacultatif
Note moyenne parmi les emplacements qui en ont une.
rowsarray of objectfacultatif
Une ligne par emplacement du périmètre (paginée).
locationIdstringfacultatif
ID de l'emplacement.
namestringfacultatif
Nom de l'emplacement.
citystringfacultatif
Ville de l'emplacement.
publishersnumberfacultatif
Emplacements publisher pour cet emplacement.
syncednumberfacultatif
Parmi eux, actuellement synchronisés.
connectionIssuesnumberfacultatif
Lignes de connecteurs natifs avec un problème de connexion.
duplicatesnumberfacultatif
Fiches en double détectées pour cet emplacement.
reviewsnumberfacultatif
Total des avis pour cet emplacement.
unrepliednumberfacultatif
Avis en attente de réponse.
avgRatingnumberfacultatif
Note moyenne de cet emplacement.
googleVerifiedbooleanfacultatif
La fiche Google est connectée et vérifiée.
googleConnectedbooleanfacultatif
Google est connecté (la vérification peut être encore en attente).
tagsarray of stringfacultatif
Tags internes de cet emplacement.
healthobjectfacultatif
L'état des fiches de cet emplacement, compté sur les mêmes fiches éligibles que sa propre vue d'ensemble des fiches.
eligibleintegerobligatoire
Fiches d'annuaire auxquelles l'emplacement est éligible : chaque site actif disponible pour son pays, son forfait et son ensemble de publishers.
liveintegerobligatoire
Parmi elles, les fiches en ligne.
inFlightintegerobligatoire
Parmi elles, les fiches envoyées en attente d'un résultat (en cours ou en attente d'approbation).
needsActionintegerobligatoire
Parmi elles, les fiches d'annuaire dont le statut nécessite une intervention.
notLiveYetintegerobligatoire
Les fiches éligibles restantes, pas encore en ligne. Null lorsque les autres nombres dépassent le total éligible.
consistentbooleanobligatoire
True lorsque live, inFlight, needsAction et notLiveYet totalisent eligible.
phasestring (preparing | submitting | settled)obligatoire
Où en est la première série de soumissions aux annuaires de l'emplacement : preparing, submitting ou settled.
citationobjectfacultatif
Les fiches de cet emplacement dans la recherche Google : ses pages de fiche en ligne actuelles, comptées par résultat. Uniquement avec withVisibility=true.
statestring (none | unchecked | measured)obligatoire
none : aucune page en ligne éligible. unchecked : des pages existent mais aucune n'a encore de résultat. measured : au moins une page a un résultat.
totalintegerobligatoire
Pages de fiche en ligne comptées.
indexedintegerobligatoire
Parmi elles, les pages affichées dans la recherche Google.
notIndexedintegerobligatoire
Parmi elles, les pages dont le résultat enregistré est « non indexée ».
pendingintegerobligatoire
Parmi elles, les pages en attente d'un résultat.
notCheckedintegerobligatoire
Parmi elles, les pages sans résultat exploitable pour l'instant.
latestEvidenceAtstringobligatoire
Date d'enregistrement du résultat de page le plus récent, ou null.
oldestEvidenceAtstringobligatoire
Le plus ancien des derniers résultats des pages, ou null. Avec latestEvidenceAt, la période sur laquelle les résultats ont été enregistrés.
mapsobjectfacultatif
Top 3 sur Google Maps pour le mot-clé par défaut de cet emplacement, à partir d'un scan enregistré. Uniquement avec withVisibility=true.
statestring (noKeywords | notMeasured | measured)obligatoire
noKeywords : aucun mot-clé suivi. notMeasured : des mots-clés sont suivis mais aucun n'a de scan mesuré. measured : un scan mesuré existe.
keywordIdstringobligatoire
L'id du mot-clé suivi.
keywordstringobligatoire
Le mot-clé suivi.
keywordCountintegerobligatoire
Nombre de mots-clés suivis pour cet emplacement.
reportIdstringobligatoire
L'id du rapport enregistré.
yearMonthstringobligatoire
Le mois couvert par ce point, au format "YYYY-MM".
measuredintegerobligatoire
Points comptés ayant une réponse mesurée (ranked ou outside). Le dénominateur de top3.
top3integerobligatoire
Points mesurés où vous vous êtes classé dans le top 3.
outsideintegerobligatoire
Points mesurés où vous n'étiez pas dans le top 20 suivi.
noDataintegerobligatoire
Points comptés dont la vérification a échoué. Pas un classement.
withheldPointsintegerobligatoire
Points enregistrés issus d'un ancien réglage de mot-clé ou de grille. Affichés comme withheld et non comptés.
missingPointsintegerobligatoire
Points de la grille sans aucun résultat enregistré.
avgRanknumberobligatoire
Rang moyen sur les points mesurés, outside comptant pour 21. Null lorsque rien n'a été mesuré.
bestRankintegerobligatoire
Meilleure position mesurée, de 1 à 20. Null lorsque tous les points mesurés sont outside.
evidencestring (proven | unverified)obligatoire
proven : chaque point compté correspond au mot-clé et à la grille actuels. unverified : un ancien scan dont le mot-clé et la grille ne peuvent pas être confirmés.
completedAtstringobligatoire
Date d'achèvement de la collecte de la grille complète à l'origine de ces résultats précis. Null sauf si cela est prouvé.
generatedAtstringobligatoire
La date enregistrée du rapport, fixée lors de sa première finalisation. Ni une heure de collecte, ni une heure de dernière mise à jour, ni une vérification en direct.
newerUnmeasuredbooleanobligatoire
True lorsqu'un scan plus récent du mot-clé n'a rien mesuré de comptabilisable, si bien qu'un scan plus ancien est affiché.
scanInProgressbooleanobligatoire
True pendant qu'un scan de grille est en cours pour cet emplacement. Valable pour tout l'emplacement : n'indique pas quels mots-clés le scan couvre.
healthobjectfacultatif
État des fiches sur tous les emplacements du périmètre, pas seulement cette page. Les nombres sont additionnés, jamais les pourcentages moyennés.
locationsintegerobligatoire
Nombre d'emplacements dans le périmètre.
eligibleintegerobligatoire
Fiches d'annuaire auxquelles l'emplacement est éligible : chaque site actif disponible pour son pays, son forfait et son ensemble de publishers.
liveintegerobligatoire
Parmi elles, les fiches en ligne.
inFlightintegerobligatoire
Parmi elles, les fiches envoyées en attente d'un résultat (en cours ou en attente d'approbation).
needsActionintegerobligatoire
Parmi elles, les fiches d'annuaire dont le statut nécessite une intervention.
notLiveYetintegerobligatoire
Les fiches éligibles restantes, pas encore en ligne. Null lorsque les autres nombres dépassent le total éligible.
locationsNeedingActionintegerobligatoire
Emplacements ayant au moins une fiche d'annuaire nécessitant une action.
connectionIssuesintegerobligatoire
Lignes de connecteurs natifs (Google/Facebook) avec un problème de connexion.
locationsWithConnectionIssuesintegerobligatoire
Emplacements ayant au moins un problème de connexion.
duplicatesintegerobligatoire
Fiches en double détectées dans le périmètre.
locationsWithDuplicatesintegerobligatoire
Emplacements ayant au moins une fiche en double détectée.
preparingintegerobligatoire
Nouveaux emplacements dont les premières soumissions sont en préparation.
submittingintegerobligatoire
Nouveaux emplacements dont les premières soumissions sont en cours d'envoi.
visibilityobjectfacultatif
Totaux de visibilité sur tous les emplacements du périmètre, pas seulement cette page. Uniquement avec withVisibility=true.
citationobjectobligatoire
Fiches dans la recherche Google, additionnées sur les emplacements ayant au moins une page de fiche en ligne.
totalintegerobligatoire
Pages de fiche en ligne comptées.
indexedintegerobligatoire
Parmi elles, les pages affichées dans la recherche Google.
notIndexedintegerobligatoire
Parmi elles, les pages dont le résultat enregistré est « non indexée ».
pendingintegerobligatoire
Parmi elles, les pages en attente d'un résultat.
notCheckedintegerobligatoire
Parmi elles, les pages sans résultat exploitable pour l'instant.
locationsobjectobligatoire
Emplacements par état de citation.
oldestEvidenceAtstringobligatoire
Le plus ancien des derniers résultats des pages, ou null. Avec latestEvidenceAt, la période sur laquelle les résultats ont été enregistrés.
latestEvidenceAtstringobligatoire
Date d'enregistrement du résultat de page le plus récent, ou null.
mapsobjectobligatoire
Top 3 sur Google Maps, additionné à partir du propre scan de chaque emplacement mesuré.
measuredintegerobligatoire
Points comptés ayant une réponse mesurée (ranked ou outside). Le dénominateur de top3.
top3integerobligatoire
Points mesurés où vous vous êtes classé dans le top 3.
locationsobjectobligatoire
Emplacements par état Maps.
completedintegerobligatoire
Emplacements mesurés dont la date de scan correspond à une collecte vérifiée de la grille complète plutôt qu'à une date de rapport enregistrée.
scannedFromstringobligatoire
Début ou fin de la période des dates de collecte vérifiées (completedAt) sur les emplacements mesurés. Null s'il n'y en a aucune.
scannedTostringobligatoire
Début ou fin de la période des dates de collecte vérifiées (completedAt) sur les emplacements mesurés. Null s'il n'y en a aucune.
reportedFromstringobligatoire
Début ou fin de la période des dates de rapport enregistrées (generatedAt) pour les emplacements mesurés sans collecte vérifiée. Null s'il n'y en a aucune. Jamais fusionnée avec la période scannée.
reportedTostringobligatoire
Début ou fin de la période des dates de rapport enregistrées (generatedAt) pour les emplacements mesurés sans collecte vérifiée. Null s'il n'y en a aucune. Jamais fusionnée avec la période scannée.
insightsobjectfacultatif
Insights dérivés calculés à partir des lignes ci-dessus.
healthnumberfacultatif
publishersSynced / publishersTotal, en pourcentage.
distributionobjectfacultatif
Emplacements répartis par taux de synchronisation (fullySynced 100 %, healthy 90-99 %, atRisk <90 %).
fullySyncednumberfacultatif
Emplacements à 100 % de synchronisation.
healthynumberfacultatif
Emplacements à 90-99 % de synchronisation.
atRisknumberfacultatif
Emplacements en dessous de 90 % de synchronisation.
weakestarray of objectfacultatif
Publishers ayant la plus faible couverture dans le périmètre.
idstringfacultatif
ID du publisher.
namestringfacultatif
Nom du publisher.
totalnumberfacultatif
Emplacements portant ce publisher.
syncednumberfacultatif
Parmi eux, synchronisés.
requiresActionnumberfacultatif
Parmi eux, nécessitant une action.
notConnectednumberfacultatif
Parmi eux, non connectés.
pctnumberfacultatif
Pourcentage synchronisé, arrondi.
directoriesarray of objectfacultatif
Tableau complet de couverture par publisher.
idstringfacultatif
ID du publisher.
namestringfacultatif
Nom du publisher.
totalnumberfacultatif
Emplacements portant ce publisher.
syncednumberfacultatif
Parmi eux, synchronisés.
requiresActionnumberfacultatif
Parmi eux, nécessitant une action.
notConnectednumberfacultatif
Parmi eux, non connectés.
pctnumberfacultatif
Pourcentage synchronisé, arrondi.
attentionarray of objectfacultatif
Cartes « à traiter » classées.
nnumberfacultatif
Nombre représenté par cette carte.
titlestringfacultatif
Titre de la carte.
substringfacultatif
Sous-titre de la carte.
tonestring (amber | blue | rose | zinc)facultatif
Ton visuel de cette carte.
filterstring (issues | duplicates | under80 | unverified | notconnected)facultatif
Clé de filtre correspondante dans le tableau des emplacements.
headlinestringfacultatif
Un titre déterministe d'une ligne sur l'état du périmètre.
fixFirstarray of objectfacultatif
Corrections prioritaires classées.
textstringfacultatif
Description de la correction.
impactstring (High | Med | Low)facultatif
Impact estimé de cette correction.
filterstring (issues | duplicates | under80 | unverified | notconnected)facultatif
Clé de filtre correspondante dans le tableau des emplacements.
totalnumberfacultatif
Total des emplacements correspondants (pour la pagination), indépendant de perPage.
pagenumberfacultatif
Page actuelle (base 1).
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/summary
Votre clé API
clientId
tags
page
perPage
withVisibility
{
  "data": {
    "summary": {
      "locations": 12,
      "publishersTotal": 96,
      "publishersSynced": 81,
      "connectionIssues": 3,
      "duplicates": 2,
      "reviews": 340,
      "avgRating": 4.6
    },
    "rows": [
      {
        "locationId": "loc_456",
        "name": "Acme Dental — Downtown",
        "city": "Austin",
        "publishers": 8,
        "synced": 7,
        "connectionIssues": 0,
        "duplicates": 0,
        "reviews": 26,
        "unreplied": 2,
        "avgRating": 4.8,
        "googleVerified": true,
        "googleConnected": true,
        "facebookConnected": true,
        "tags": [
          "vip"
        ]
      }
    ],
    "insights": {
      "health": 84,
      "distribution": {
        "fullySynced": 9,
        "healthy": 2,
        "atRisk": 1
      },
      "weakest": [
        {
          "locationId": "loc_789",
          "name": "Acme Dental — Eastside",
          "health": 40
        }
      ],
      "directories": [
        {
          "id": "google",
          "name": "Google Maps",
          "total": 12,
          "synced": 11,
          "requiresAction": 0,
          "notConnected": 1,
          "pct": 92
        }
      ],
      "attention": [
        {
          "n": 1,
          "title": "1 location under 90% synced",
          "sub": "Listings not fully propagated",
          "tone": "amber",
          "filter": "under80"
        }
      ],
      "headline": "84% listing health — 1 location under 90% synced needs attention.",
      "fixFirst": [
        {
          "text": "Reconnect 1 location's listing sync.",
          "impact": "Med"
        }
      ]
    },
    "total": 12,
    "page": 1,
    "perPage": 50
  }
}

Guides qui utilisent cet endpoint