Synupv1
Créer une clé
v1Ressources/SEO/getObtenir le classement des concurrents d'un établissement

Obtenir le classement des concurrents d'un établissement

Renvoie les entreprises qui dominent la grille de classement de cet établissement pour son mot-clé le plus récemment suivi, classées selon la part de la grille qu'elles occupent dans le top 3. Inclut votre propre entreprise (isYou) pour comparaison, et signale les entrées déjà présentes dans votre registre de concurrents suivis avec leur ID de registre.

get/api/v1/seo/competitors
seo:read
Paramètres de requête
locationIdstringobligatoire
L'établissement à consulter.
clientIdstringfacultatif
Le client de l'établissement.
Réponse
dataobjectfacultatif
countnumberfacultatif
Nombre de concurrents renvoyés.
competitorsarray of objectfacultatif
Le classement des concurrents, incluant votre propre entreprise.
idstringfacultatif
Un identifiant pour cette entreprise (son place ID, ou une clé dérivée quand aucun place ID n'est disponible).
competitorIdstringfacultatif
ID dans votre registre de concurrents suivis, présent uniquement si cette entreprise y est déjà suivie.
namestringfacultatif
Nom de l'entreprise.
isYoubooleanfacultatif
Si cette ligne est votre propre entreprise.
ratingnumberfacultatif
Note en étoiles, ou null.
reviewCountnumberfacultatif
Nombre d'avis, ou null.
avgRanknumberfacultatif
Classement moyen sur les points de grille où cette entreprise est apparue, ou null.
top3Pctnumberfacultatif
Pourcentage de points de grille où cette entreprise est classée dans le top 3, moyenné sur tous les mots-clés suivis.
gridPointsnumberfacultatif
Nombre de points de grille où cette entreprise est apparue.
categorystringfacultatif
Catégorie d'activité, ou null.
websitestringfacultatif
Site web de l'entreprise, ou null (non renvoyé par la source de données de recherche locale).
keywordBreakdownarray of objectfacultatif
La couverture top 3 de cette entreprise détaillée par mot-clé suivi.
keywordstringfacultatif
Le mot-clé suivi.
top3Pctnumberfacultatif
Pourcentage des points de grille de ce mot-clé où cette entreprise est classée dans le top 3.
featureComparisonarray of objectfacultatif
Lignes de comparaison fonctionnalité par fonctionnalité par rapport à votre entreprise, le cas échéant.
featurestringfacultatif
competitorbooleanfacultatif
youbooleanfacultatif
hoursComparisonarray of objectfacultatif
Lignes de comparaison d'horaires d'ouverture par rapport à votre entreprise, le cas échéant.
daystringfacultatif
competitorstringfacultatif
youstringfacultatif
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/competitors
Votre clé API
locationId *
clientId
{
  "data": {
    "count": 2,
    "competitors": [
      {
        "id": "cm_comp_1",
        "competitorId": "cm_competitor_1",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "rating": 4.6,
        "reviewCount": 210,
        "avgRank": 4.2,
        "top3Pct": 44,
        "gridPoints": 25,
        "category": "Dentist",
        "website": "https://acmedental.example.com",
        "keywordBreakdown": [
          {
            "keyword": "dentist near me",
            "top3Pct": 60
          }
        ],
        "featureComparison": [
          {
            "feature": "Online booking",
            "competitor": false,
            "you": true
          }
        ],
        "hoursComparison": [
          {
            "day": "Monday",
            "competitor": "9am–5pm",
            "you": "8am–6pm"
          }
        ]
      }
    ]
  }
}