Synup
Créer une clé
v1Ressources/SEO/getObtenir la synthèse de classement d'un établissement

Obtenir la synthèse de classement d'un établissement

Renvoie les mots-clés suivis, la tendance de classement mensuelle, la grille de classement et les cartes de statistiques pour un établissement. Passez keywordId pour restreindre la grille à un seul mot-clé, ou month (YYYY-MM) pour la figer sur un mois précis plutôt que sur le dernier rapport mesuré de chaque mot-clé.

get/api/v1/seo/keywords
seo:read
Paramètres de requête
locationIdstringobligatoire
L'établissement à consulter.
clientIdstringfacultatif
Le client de l'établissement.
keywordIdstringfacultatif
Restreint la grille à un seul mot-clé suivi. À omettre pour la grille agrégée du meilleur classement par cellule sur tous les mots-clés actifs.
monthstringfacultatif
Fige la grille et les statistiques sur ce mois (YYYY-MM) au lieu du dernier rapport mesuré de chaque mot-clé.
Réponse
dataobjectfacultatif
Des champs internes supplémentaires peuvent être présents mais ne font pas partie du contrat stable — ne vous fiez qu'aux champs documentés ici.
keywordsarray of objectfacultatif
Mots-clés suivis pour cet établissement, chacun avec son classement actuel et sa tendance mensuelle.
idstringfacultatif
Identifiant unique du mot-clé suivi.
keywordstringfacultatif
Le texte du mot-clé.
avgRanknumberfacultatif
Le dernier classement moyen mesuré du mot-clé sur la grille (plus bas est meilleur ; null si jamais mesuré ou pas classé).
monthlyarray of objectfacultatif
Le classement moyen de ce mot-clé pour chaque mois disposant d'un rapport.
monthstringfacultatif
ranknumberfacultatif
monthsarray of objectfacultatif
Chaque mois disposant d'au moins un rapport mesuré, du plus ancien au plus récent, avec le classement moyen moyen sur les mots-clés pour ce mois.
keystringfacultatif
Mois au format YYYY-MM.
labelstringfacultatif
Étiquette lisible pour le mois, par ex. "Aug 2026".
avgRanknumberfacultatif
Classement moyen moyen sur les mots-clés suivis pour ce mois, ou null.
gridarray of objectfacultatif
La grille de classement : une entrée par point scrapé, fusionnée sur le ou les mots-clés/mois concernés.
idstringfacultatif
rowintegerfacultatif
Index de ligne de la grille.
colintegerfacultatif
Index de colonne de la grille.
latnumberfacultatif
Latitude de ce point de grille.
lngnumberfacultatif
Longitude de ce point de grille.
ranknumberfacultatif
Classement trouvé à ce point (plus bas est meilleur) ; null si non mesuré, les valeurs au-delà de 20 signifient "20+".
excludedbooleanfacultatif
Si ce point est exclu des calculs de statistiques de l'établissement.
waterbooleanfacultatif
Si ce point se trouve dans l'eau (mer, lac, large rivière) et n'est compté que si l'établissement a choisi d'inclure les points en eau.
statsobjectfacultatif
Statistiques de classement agrégées sur la grille active.
top3Pctnumberfacultatif
Pourcentage de points de grille classés dans le top 3, ou null.
top10Pctnumberfacultatif
Pourcentage de points de grille classés dans le top 10, ou null.
avgRanknumberfacultatif
Classement moyen sur la grille, ou null.
statCardsobjectfacultatif
Cartes de mise en avant résumant le meilleur/pire mot-clé de l'établissement et la plus grande variation mois sur mois.
bestobjectfacultatif
Le mot-clé avec le meilleur (le plus bas) classement moyen actuel, ou null si aucun n'a encore été classé.
keywordstringfacultatif
avgRanknumberfacultatif
worstobjectfacultatif
Le mot-clé avec le pire classement moyen actuel, ou null.
keywordstringfacultatif
avgRanknumberfacultatif
gainerobjectfacultatif
Le mot-clé dont le classement s'est le plus amélioré entre son premier et son dernier mois, ou null.
keywordstringfacultatif
fromnumberfacultatif
tonumberfacultatif
dropperobjectfacultatif
Le mot-clé dont le classement s'est le plus dégradé entre son premier et son dernier mois, ou null.
keywordstringfacultatif
fromnumberfacultatif
tonumberfacultatif
notRankingCountnumberfacultatif
Points de grille mesurés avec succès mais classés hors du top 20, ou null.
noDataCountnumberfacultatif
Points de grille qui n'ont pas pu être mesurés du tout (le scrape a échoué), distinct de non classé, ou null.
centerobjectfacultatif
Le point central de la carte pour la grille de cet établissement (son emplacement commercial), ou null si pas encore configuré.
latnumberfacultatif
lngnumberfacultatif
includeWaterPointsbooleanfacultatif
Si cet établissement a choisi de compter les points de grille situés dans l'eau.
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.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/seo/keywords
Votre clé API
locationId *
clientId
keywordId
month
{
  "data": {
    "keywords": [
      {
        "id": "cm_kw_abc123",
        "keyword": "dentist near me",
        "avgRank": 4.2,
        "monthly": [
          {
            "month": "2026-01",
            "rank": 5.1
          },
          {
            "month": "2026-02",
            "rank": 4.2
          }
        ]
      }
    ],
    "months": [
      {
        "key": "2026-01",
        "label": "Jan 2026",
        "avgRank": 5.1
      },
      {
        "key": "2026-02",
        "label": "Feb 2026",
        "avgRank": 4.2
      }
    ],
    "grid": [
      {
        "id": "cm_pt_1",
        "row": 0,
        "col": 0,
        "lat": 30.2682,
        "lng": -97.7441,
        "rank": 3,
        "excluded": false,
        "water": false
      }
    ],
    "stats": {
      "top3Pct": 44,
      "top10Pct": 78,
      "avgRank": 4.2
    },
    "statCards": {
      "best": {
        "keyword": "dentist near me",
        "avgRank": 4.2
      },
      "worst": {
        "keyword": "emergency dentist austin",
        "avgRank": 9.6
      },
      "gainer": {
        "keyword": "dentist near me",
        "from": 5.1,
        "to": 4.2
      },
      "dropper": {
        "keyword": "family dentist",
        "from": 3.8,
        "to": 5.2
      },
      "notRankingCount": 1,
      "noDataCount": 0
    },
    "center": {
      "lat": 30.2672,
      "lng": -97.7431
    },
    "includeWaterPoints": false
  }
}

Guides qui utilisent cet endpoint