Obtenir les statistiques d’interaction

Paramètres

Chemin

Nom	Type	Obligatoire	Description
locationId	string	obligatoire	Location ID, a raw numeric database ID (e.g. `1800289`) or its Base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`).

Chaîne de requête

Nom	Type	Obligatoire	Description	Par défaut
startDate	string	facultatif	Start of the analytics period (YYYY-MM-DD). Optional here: it narrows the window the KPIs and their deltas are computed over. Required by the timeline route.	—
endDate	string	facultatif	End of the analytics period (YYYY-MM-DD). Optional here, required by the timeline route.	—

Réponses

200Overview analytics for the location.

Response

{  "data": {    "interactionsAnalyticsStats": {      "stats": [        { "name": "total-reviews", "value": 128, "delta": 6.67 },        { "name": "new-reviews", "value": 9, "delta": -25 },        { "name": "overall-rating", "value": 4.43, "delta": 2.31 },        { "name": "review-response-rate", "value": 62.5, "delta": 12.5 }      ]    }  }}

401Unauthenticated, missing or invalid API key.

Renvoie les statistiques sur les avis d’un seul établissement. Cette route renvoie les KPI de la vue d’ensemble ; deux routes associées renvoient les autres formes de statistiques, chacune disposant de sa propre page :

review-analytics-overview (cette page) : statistiques globales : total-reviews, new-reviews, overall-rating (moyenne, de 1 à 5) et review-response-rate (pourcentage). Clé de réponse : interactionsAnalyticsStats.
review-analytics-timeline : série chronologique quotidienne du nombre d’interactions et de la note moyenne pour une plage de dates. Clé de réponse : interactionsChartData. Nécessite startDate et endDate.
review-analytics-sites-stats : ventilation par plateforme indiquant la note moyenne, le nombre total d’interactions et l’activité récente pour chaque site source. Clé de réponse : interactionsSitesStats.

Chaque entrée de stats contient un name, un value et un delta. delta représente la variation en pourcentage par rapport à la période équivalente précédente (pour un compte nouvellement créé sans période antérieure, la valeur indiquée est 100).

Cas d’utilisation : une vignette de synthèse des performances d’un établissement

Pour afficher une vignette « Les avis en un coup d’œil » dans le tableau de bord d’un magasin, appelez cet endpoint avec uniquement l’identifiant de l’établissement ; aucune plage de dates n’est nécessaire pour la vue d’ensemble. Lisez overall-rating pour afficher la note moyenne en étoiles comme indicateur principal et review-response-rate pour indiquer le nombre d’avis auxquels l’équipe a répondu. Associez cet endpoint à review-analytics-timeline (en transmettant startDate/endDate) lorsque la vignette doit inclure un mini-graphique de tendance sur 30 jours.

locationId accepte indifféremment l’identifiant numérique brut de la base de données ou l’identifiant Relay en Base64, ce qui vous permet de réutiliser l’identifiant obtenu via Lister tous les établissements.