Synup
Créer une clé
v1Ressources/Fiches publiées/getObtenir le Share of Voice

Obtenir le Share of Voice

Votre part de Grid Rank face aux concurrents nommés, vos mots-clés les plus performants classés par part top-3 actuelle, et une tendance mensuelle de rang moyen sur la fenêtre — pour un emplacement.

get/api/v1/seo/share-of-voice
seo:read
Paramètres de requête
locationIdstringobligatoire
L'emplacement à consulter. Retrouvez-le avec GET /api/v1/locations.
clientIdstringfacultatif
Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.
fromstringfacultatif
Début de la fenêtre (date ISO). Par défaut, il y a 30 jours.
tostringfacultatif
Fin de la fenêtre (date ISO). Par défaut, maintenant.
keywordIdstringfacultatif
Un id de mot-clé suivi issu de maps.keywords pour lequel lire le Top 3 sur Google Maps. Omettez-le pour utiliser le mot-clé le plus récent ayant un scan mesuré.
Réponse
dataobjectfacultatif
comparisonobjectfacultatif
Vous face aux concurrents nommés selon la part top-3 du grid.
availablebooleanfacultatif
Indique si cet établissement dispose de données de grid-rank pour calculer le Share of Voice.
rowsarray of objectfacultatif
Une ligne par entreprise dans la comparaison — vous et vos concurrents nommés.
namestringfacultatif
Le nom de l'entreprise, ou le nom de votre propre client pour votre propre ligne.
top3Pctnumberfacultatif
Part des mots-clés suivis pour lesquels cette entreprise se classe dans le top 3 (0–100), ou null en cas de données insuffisantes.
isYoubooleanfacultatif
True sur la ligne correspondant à votre propre établissement. Omis (jamais false) sur les lignes des concurrents.
keywordsobjectfacultatif
Les mots-clés de cet emplacement, classés par part top-3 la plus récente.
availablebooleanfacultatif
Indique si cet établissement dispose de données de grid-rank pour calculer le Share of Voice.
rowsarray of objectfacultatif
Une ligne par mot-clé suivi.
keywordstringfacultatif
Le mot-clé suivi.
top3Pctnumberfacultatif
Part des mots-clés suivis pour lesquels cette entreprise se classe dans le top 3 (0–100), ou null en cas de données insuffisantes.
avgRanknumberfacultatif
Rang moyen sur la période, ou null en cas de données insuffisantes.
performanceobjectfacultatif
Tendance mensuelle de rang moyen par mot-clé, bornée par from/to.
availablebooleanfacultatif
Indique si cet établissement dispose de données de grid-rank pour calculer le Share of Voice.
seriesarray of objectfacultatif
Une série par mot-clé suivi.
keywordstringfacultatif
Le mot-clé suivi.
pointsarray of objectfacultatif
Points de données de rang moyen mensuel pour ce mot-clé.
mapsobjectfacultatif
Top 3 sur Google Maps pour un mot-clé, à partir d'un scan de grille enregistré.
availablebooleanobligatoire
False lorsque votre clé ne peut pas lire cet emplacement.
keywordsarray of objectobligatoire
Les mots-clés suivis actifs de l'emplacement, du plus récent au plus ancien.
idstringobligatoire
L'id du mot-clé suivi.
keywordstringobligatoire
Le mot-clé suivi.
measuredbooleanobligatoire
True lorsqu'un scan enregistré avec au moins un point mesuré existe pour ce mot-clé.
selectedKeywordIdstringobligatoire
Le mot-clé auquel se rapportent tous les chiffres de maps. Null lorsque l'emplacement ne suit aucun mot-clé.
selectionstring (requested | default)obligatoire
requested : vous avez indiqué le mot-clé avec keywordId. default : le mot-clé le plus récent ayant un scan mesuré, sinon le mot-clé le plus récent.
reportobjectobligatoire
Le scan le plus récent du mot-clé sélectionné ayant un point mesuré. Null signifie aucun scan mesuré, jamais 0 %.
idstringobligatoire
L'id du rapport enregistré.
keywordIdstringobligatoire
L'id du mot-clé suivi.
keywordstringobligatoire
Le mot-clé suivi.
yearMonthstringobligatoire
Le mois couvert par ce point, au format "YYYY-MM".
gridSizeintegerobligatoire
La longueur de côté configurée de la grille au moment du scan. points contient les points réels.
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.
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.
pointsarray of objectobligatoire
Chaque point de grille enregistré, dans l'ordre des lignes et des colonnes, avec son état.
missingPointsintegerobligatoire
Points de la grille sans aucun résultat enregistré.
withheldPointsintegerobligatoire
Points enregistrés issus d'un ancien réglage de mot-clé ou de grille. Affichés comme withheld et non comptés.
countedintegerobligatoire
Points enregistrés que cet emplacement compte, hors points water et excluded.
measuredintegerobligatoire
Points comptés ayant une réponse mesurée (ranked ou outside). Le dénominateur de top3.
noDataintegerobligatoire
Points comptés dont la vérification a échoué. Pas un classement.
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.
top3Pctnumberobligatoire
Part des mots-clés suivis pour lesquels cette entreprise se classe dans le top 3 (0–100), ou null en cas de données insuffisantes.
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.
businessPointobjectobligatoire
Le point échantillonné le plus proche des coordonnées de l'emplacement. Un point de recherche, pas l'adresse elle-même. Null lorsque l'emplacement n'a pas de coordonnées.
newerUnmeasuredobjectobligatoire
Un scan plus récent du mot-clé qui n'a rien mesuré de comptabilisable, signalé à côté de report et non à sa place. Null s'il n'y en a pas.
yearMonthstringobligatoire
Le mois couvert par ce point, au format "YYYY-MM".
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.
competitorsarray of objectobligatoire
Vous et les principaux concurrents, comptés sur les points mesurés du rapport. Vide sans rapport.
idstringobligatoire
Un id stable pour l'entreprise : id: suivi de son id de lieu Google, sinon son nom et son adresse. "you" sur votre propre ligne.
namestringobligatoire
Le nom de l'entreprise tel qu'enregistré. Peut être vide, et l'est sur votre propre ligne.
addressstringobligatoire
L'adresse telle qu'enregistrée, lorsque le scan en a capturé une. Permet de distinguer des succursales de même nom.
isYoubooleanobligatoire
True sur la ligne correspondant à votre propre établissement. Omis (jamais false) sur les lignes des concurrents.
top3Spotsintegerobligatoire
Points mesurés où cette entreprise s'est classée dans le top 3. Les entreprises partagent des points, donc les lignes ne s'additionnent pas pour donner le total.
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.
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/share-of-voice
Votre clé API
locationId *
clientId
from
to
keywordId
{
  "data": {
    "comparison": {
      "available": true,
      "rows": [
        {
          "name": "Acme Dental — Downtown",
          "top3Pct": 62,
          "isYou": true
        },
        {
          "name": "Bright Smiles Dental",
          "top3Pct": 74
        }
      ]
    },
    "keywords": {
      "available": true,
      "rows": [
        {
          "keyword": "dentist near me",
          "top3Pct": 62,
          "avgRank": 3.2
        }
      ]
    },
    "performance": {
      "available": true,
      "series": [
        {
          "keyword": "dentist near me",
          "points": [
            {
              "yearMonth": "2026-01",
              "avgRank": 3.6
            },
            {
              "yearMonth": "2026-02",
              "avgRank": 3.2
            }
          ]
        }
      ]
    }
  }
}

Guides qui utilisent cet endpoint