Synup
Créer une clé
v1Ressources/SEO/getObtenir la synthèse de classement tous établissements

Obtenir la synthèse de classement tous établissements

Renvoie une ligne de synthèse par établissement disposant d'au moins un rapport de classement, éventuellement restreinte à un client et/ou à des tags d'établissement. Une clé restreinte à des clients spécifiques doit passer clientId.

get/api/v1/seo/rollup
seo:read
Paramètres de requête
clientIdstringfacultatif
Restreint les résultats à un client. Quand votre clé est limitée à des clients spécifiques, ceci est obligatoire.
tagsstringfacultatif
Noms de tags d'établissement séparés par des virgules. Seuls les établissements portant au moins un de ces tags sont inclus.
Réponse
dataobjectfacultatif
countnumberfacultatif
Nombre de lignes renvoyées.
rowsarray of objectfacultatif
Une ligne par établissement disposant d'au moins un rapport de classement.
idstringfacultatif
Identifiant unique de l'établissement.
locationNamestringfacultatif
Le nom commercial de l'établissement.
citystringfacultatif
Ville, ou null.
avgRanknumberfacultatif
Classement moyen moyen sur les mots-clés actifs de l'établissement, ou null.
top3Pctnumberfacultatif
Pourcentage moyen de points de grille dans le top 3 sur les mots-clés de l'établissement, ou null.
top10Pctnumberfacultatif
Pourcentage moyen de points de grille dans le top 10 sur les mots-clés de l'établissement, ou null.
bestKeywordobjectfacultatif
Le mot-clé le mieux classé de l'établissement, ou null.
keywordstringfacultatif
avgRanknumberfacultatif
tagsarray of stringfacultatif
Les tags internes de l'établissement.
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/seo/rollup
Votre clé API
clientId
tags
{
  "data": {
    "count": 2,
    "rows": [
      {
        "id": "cm_loc_1",
        "locationName": "Acme Dental — Downtown",
        "city": "Austin",
        "avgRank": 4.2,
        "top3Pct": 44,
        "top10Pct": 78,
        "bestKeyword": {
          "keyword": "dentist near me",
          "avgRank": 4.2
        },
        "tags": [
          "priority",
          "downtown"
        ]
      }
    ]
  }
}

Guides qui utilisent cet endpoint