Synup
Créer une clé
v1Ressources/Reviews/getObtenir un résumé des statistiques d'avis

Obtenir un résumé des statistiques d'avis

Statistiques d'avis agrégées sur les emplacements de ce client (ou de toute l'agence) : nombre, note moyenne, distribution des notes, mix de sentiment, taux de réponse, répartition par plateforme et une tendance mensuelle. Restreindre à un sous-ensemble avec tags.

get/api/v1/reviews/analytics/summary
reviews: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.
monthsintegerfacultatif
Durée de la tendance en mois. Par défaut 6.
Réponse
dataobjectfacultatif
locationsnumberfacultatif
Nombre d'emplacements dans le périmètre.
countnumberfacultatif
Total des avis dans le périmètre.
avgRatingnumberfacultatif
Note moyenne sur le périmètre.
distributionobjectfacultatif
Nombre d'avis par note en étoiles (1-5).
sentimentobjectfacultatif
Nombre d'avis par sentiment.
positivenumberfacultatif
neutralnumberfacultatif
negativenumberfacultatif
responseRatenumberfacultatif
Pourcentage d'avis avec une réponse.
byPlatformarray of objectfacultatif
Nombre et note moyenne par plateforme.
platformstringfacultatif
countnumberfacultatif
avgRatingnumberfacultatif
trendarray of objectfacultatif
Nombre mensuel et note moyenne.
monthstringfacultatif
countnumberfacultatif
avgRatingnumberfacultatif
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/reviews/analytics/summary
Votre clé API
clientId
tags
months
{
  "data": {
    "locations": 5,
    "count": 210,
    "avgRating": 4.4,
    "distribution": {
      "1": 4,
      "2": 8,
      "3": 12,
      "4": 60,
      "5": 126
    },
    "sentiment": {
      "positive": 172,
      "neutral": 24,
      "negative": 14
    },
    "responseRate": 91,
    "byPlatform": [
      {
        "platform": "google",
        "label": "Google",
        "count": 160,
        "avgRating": 4.5
      }
    ],
    "trend": [
      {
        "month": "2026-02",
        "count": 114,
        "avgRating": 4.4
      }
    ]
  }
}

Guides qui utilisent cette ressource