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.
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.
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
{
  "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