Synupv1
Créer une clé
v1Ressources/Reviews

Reviews

Consultez et répondez aux avis clients d'un établissement.

Renvoie les avis d'un établissement. locationId et clientId sont tous deux obligatoires.

Lister les avis

get/api/v1/reviews
reviews:read
Paramètres de requête
locationIdstringobligatoire
L'établissement à consulter.
clientIdstringobligatoire
Le client de l'établissement.
sitesstringfacultatif
Plateformes d'avis à inclure, séparées par des virgules (ex. google,facebook).
ratingsstringfacultatif
Notes en étoiles à inclure, séparées par des virgules (ex. 1,2).
sentimentstringfacultatif
Sentiments à inclure, séparés par des virgules (positive, neutral, negative).
statusstring (responded | unreplied)facultatif
Filtrer par statut de réponse : responded ou unreplied.
keywordstringfacultatif
Recherche en texte libre dans le corps de l'avis et l'auteur.
fromstringfacultatif
Début de la fenêtre (date ISO).
tostringfacultatif
Fin de la fenêtre (date ISO).
sortstring (newest | oldest | lowest | highest)facultatif
Ordre de tri : newest, oldest, lowest ou highest.
deletedstring (1)facultatif
Passer 1 pour afficher les avis supprimés/absents au lieu des avis actifs.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente.
limitintegerfacultatif
Avis par page, 1-100. Par défaut 30.
Réponse
dataobjectfacultatif
foundbooleanfacultatif
Si l'établissement a été trouvé et était accessible à cette clé.
reviewsarray of objectfacultatif
Les avis eux-mêmes.
idstringfacultatif
Identifiant unique de l'avis.
authorstringfacultatif
Nom de l'auteur de l'avis, ou null si non fourni par la source.
ratingnumberfacultatif
Note en étoiles, ou null.
bodystringfacultatif
Le texte de l'avis.
reviewDatestringfacultatif
Date de publication de l'avis, au format horodatage ISO 8601, ou null.
platformstringfacultatif
Plateforme source, par ex. google, facebook.
platformLabelstringfacultatif
Nom d'affichage de la plateforme source, ou null.
sentimentstringfacultatif
Sentiment détecté de l'avis, ou null.
replyobjectfacultatif
La réponse de l'entreprise, le cas échéant, ou null.
authorstringfacultatif
bodystringfacultatif
datestringfacultatif
reviewUrlstringfacultatif
Lien vers l'avis sur sa plateforme source, ou null.
respondablebooleanfacultatif
Si une réponse peut encore être publiée à cet avis.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null s'il n'y a plus de résultats.
totalnumberfacultatif
Nombre total d'avis correspondant à la requête.
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/reviews
Votre clé API
locationId *
clientId *
sites
ratings
sentiment
status
keyword
from
to
sort
deleted
cursor
limit
{
  "data": {
    "found": true,
    "reviews": [
      {
        "id": "rev_1",
        "author": "Jane D.",
        "rating": 5,
        "body": "Great service!",
        "reviewDate": "2026-02-01T12:00:00.000Z",
        "platform": "google",
        "platformLabel": "Google",
        "sentiment": "positive",
        "reply": null,
        "reviewUrl": "https://google.com/...",
        "respondable": true
      }
    ],
    "nextCursor": null,
    "total": 1
  }
}
v1Ressources/Reviews/getObtenir le résumé des avis

Renvoie un résumé consolidé des avis de toute votre agence (ou d'un client) — répartition des notes, volume et tendance sur la période sélectionnée.

Obtenir le résumé des avis

get/api/v1/reviews/summary
reviews:read
Paramètres de requête
clientIdstringfacultatif
Limite aux avis d'un client. Omis, cela résume tous les avis que votre clé peut voir.
tagsstringfacultatif
Limite aux emplacements portant l'une de ces étiquettes internes séparées par des virgules.
fromstringfacultatif
Début de la période (inclus), au format AAAA-MM-JJ. Par défaut, une fenêtre glissante récente.
tostringfacultatif
Fin de la période (incluse), au format AAAA-MM-JJ. Par défaut, aujourd'hui.
Réponse
dataobjectfacultatif
Le résumé consolidé — répartition des notes, volume d'avis et données de tendance pour la période sélectionnée.
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/summary
Votre clé API
clientId
tags
from
to
{}
v1Ressources/Reviews/getLister les sources d'avis

Chaque source d'avis pour un emplacement — plateformes connectées (Google, Facebook, ...) plus des URLs personnalisées (Yelp, TripAdvisor, ...), avec statut et état masqué.

Lister les sources d'avis

get/api/v1/reviews/sources
reviews:read
Paramètres de requête
locationIdstringobligatoire
L'emplacement à consulter.
clientIdstringobligatoire
Le client de l'emplacement.
Réponse
dataobjectfacultatif
sourcesarray of objectfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/sources
Votre clé API
locationId *
clientId *
{}
v1Ressources/Reviews/postAjouter une source d'avis personnalisée

Ajoute une URL de page d'avis personnalisée (Yelp, TripAdvisor, Trustpilot ou toute page d'avis d'entreprise) comme source pour cet emplacement. La plateforme est détectée automatiquement à partir de l'URL. Ne valide pas l'URL en direct avant l'ajout — une URL incorrecte apparaît plus tard comme un scraping échoué.

Ajouter une source d'avis personnalisée

post/api/v1/reviews/sources
reviews:write
Corps de la requête
locationIdstringobligatoire
clientIdstringobligatoire
urlstringobligatoire
L'URL de la page d'avis à ajouter.
Réponse
dataobjectfacultatif
idstringfacultatif
L'id de la source personnalisée nouvellement créée.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409Cette URL est déjà une source pour cet emplacement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/sources
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/patchMettre à jour une source d'avis

Masquer/afficher une source (plateforme automatique ou personnalisée), ou modifier l'intervalle de récupération d'une source personnalisée.

Mettre à jour une source d'avis

patch/api/v1/reviews/sources/{id}
reviews:write
Paramètres de requête
idstringobligatoire
La clé de la source — un slug de plateforme automatique (ex. "google") ou l'id d'une source personnalisée.
Corps de la requête
typestring (auto | custom)obligatoire
locationIdstringobligatoire
clientIdstringobligatoire
hidebooleanfacultatif
Définir sur true pour masquer cette source de la vue des avis, false pour l'afficher.
fetchIntervalHoursintegerfacultatif
Nouvel intervalle de scraping en heures. Sources personnalisées uniquement.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
patch/api/v1/reviews/sources/{id}
Votre clé API
id *
Corps de la requête*
{}
v1Ressources/Reviews/deleteSupprimer une source d'avis personnalisée

Supprime définitivement une source d'avis personnalisée et arrête son scraping.

Supprimer une source d'avis personnalisée

delete/api/v1/reviews/sources/{id}
reviews:write
Paramètres de requête
idstringobligatoire
locationIdstringobligatoire
clientIdstringobligatoire
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/reviews/sources/{id}
Votre clé API
id *
locationId *
clientId *
{}
v1Ressources/Reviews/postRéessayer une source d'avis bloquée/échouée

Réinitialise l'état d'échec d'une source personnalisée et la remet en file pour un scraping immédiat.

Réessayer une source d'avis bloquée/échouée

post/api/v1/reviews/sources/{id}/retry
reviews:write
Paramètres de requête
idstringobligatoire
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/sources/{id}/retry
Votre clé API
id *
{}
v1Ressources/Reviews/getObtenir les statistiques d'avis

KPI (avec écarts période sur période), une tendance mensuelle (volume, note, mix de sentiment, taux de réponse), distribution des notes, répartition par plateforme, horaires par jour de la semaine, un benchmark d'agence, des thèmes et un résumé IA — pour un emplacement.

Obtenir les statistiques d'avis

get/api/v1/reviews/analytics
reviews:read
Paramètres de requête
locationIdstringobligatoire
L'emplacement à consulter.
clientIdstringobligatoire
Le client de l'emplacement.
kpiDaysinteger (7 | 30 | 90)facultatif
Fenêtre de KPI en jours : 7, 30 ou 90. Par défaut 30.
trendMonthsinteger (3 | 6 | 12)facultatif
Durée de la tendance en mois : 3, 6 ou 12. Par défaut 6.
Réponse
dataobjectfacultatif
Le contenu complet des Statistiques d'avis.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
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
Votre clé API
locationId *
clientId *
kpiDays
trendMonths
{}
v1Ressources/Reviews/getObtenir 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.

Obtenir un résumé des statistiques d'avis

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
{}
v1Ressources/Reviews/getLister les concurrents suivis

Les concurrents suivis pour un emplacement.

Lister les concurrents suivis

get/api/v1/reviews/competitors
reviews:read
Paramètres de requête
locationIdstringfacultatif
apiDocs.resources.reviews.competitors.get.paramsLocationId
clientIdstringfacultatif
apiDocs.resources.reviews.competitors.get.paramsClientId
Réponse
dataobjectfacultatif
competitorsarray of objectfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/competitors
Votre clé API
locationId
clientId
{}
v1Ressources/Reviews/postAjouter un concurrent

Commence à suivre un concurrent par son nom pour un emplacement.

Ajouter un concurrent

post/api/v1/reviews/competitors
reviews:write
Corps de la requête
locationIdstringfacultatif
apiDocs.resources.reviews.competitors.post.paramsLocationId
clientIdstringfacultatif
apiDocs.resources.reviews.competitors.post.paramsClientId
namestringobligatoire
Le nom commercial du concurrent.
Réponse
dataobjectfacultatif
competitorobjectfacultatif
Ligne de profil d'un concurrent (id, nom, source, épinglé, etc.).
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/competitors
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/getObtenir l'analyse concurrentielle des avis

Compare les avis d'un emplacement à ceux de ses concurrents suivis : tableau de bord, forces/lacunes, et vélocité des avis + part de voix.

Obtenir l'analyse concurrentielle des avis

get/api/v1/reviews/competitors/analysis
reviews:read
Paramètres de requête
locationIdstringobligatoire
clientIdstringobligatoire
Réponse
dataobjectfacultatif
Le contenu complet de l'analyse concurrentielle (tableau de bord, forces/lacunes, vélocité).
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/competitors/analysis
Votre clé API
locationId *
clientId *
{}
v1Ressources/Reviews/deleteSupprimer un concurrent suivi

Arrête définitivement le suivi d'un concurrent par son id.

Supprimer un concurrent suivi

delete/api/v1/reviews/competitors/{id}
reviews:write
Paramètres de requête
idstringobligatoire
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.
delete/api/v1/reviews/competitors/{id}
Votre clé API
id *
{}
v1Ressources/Reviews/postActualiser les avis d'un concurrent

Récupère à nouveau les avis Google d'un concurrent suivi.

Actualiser les avis d'un concurrent

post/api/v1/reviews/competitors/{id}/refresh
reviews:write
Paramètres de requête
idstringobligatoire
Réponse
dataobjectfacultatif
okbooleanfacultatif
notestringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/competitors/{id}/refresh
Votre clé API
id *
{}
v1Ressources/Reviews/postapiDocs.resources.reviews.competitorsRefresh.summary

apiDocs.resources.reviews.competitorsRefresh.description

apiDocs.resources.reviews.competitorsRefresh.summary

post/api/v1/reviews/competitors/refresh
reviews:write
Corps de la requête
clientIdstringobligatoire
apiDocs.resources.reviews.competitorsRefresh.paramsClientId
Réponse
dataobjectfacultatif
okbooleanfacultatif
queuedbooleanfacultatif
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.
post/api/v1/reviews/competitors/refresh
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/getapiDocs.resources.reviews.notes.get.summary

apiDocs.resources.reviews.notes.get.description

apiDocs.resources.reviews.notes.get.summary

get/api/v1/reviews/notes
reviews:read
Paramètres de requête
reviewIdstringobligatoire
apiDocs.resources.reviews.notes.get.paramsReviewId
Réponse
dataobjectfacultatif
notesarray of objectfacultatif
idstringfacultatif
apiDocs.resources.reviews.notes.fields.id
bodystringfacultatif
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringfacultatif
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringfacultatif
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringfacultatif
apiDocs.resources.reviews.notes.fields.createdAt
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/notes
Votre clé API
reviewId *
{}
v1Ressources/Reviews/postapiDocs.resources.reviews.notes.post.summary

apiDocs.resources.reviews.notes.post.description

apiDocs.resources.reviews.notes.post.summary

post/api/v1/reviews/notes
reviews:write
Corps de la requête
reviewIdstringobligatoire
apiDocs.resources.reviews.notes.post.paramsReviewId
bodystringobligatoire
apiDocs.resources.reviews.notes.post.paramsBody
Réponse
dataobjectfacultatif
idstringfacultatif
apiDocs.resources.reviews.notes.fields.id
bodystringfacultatif
apiDocs.resources.reviews.notes.fields.body
authorUserIdstringfacultatif
apiDocs.resources.reviews.notes.fields.authorUserId
authorNamestringfacultatif
apiDocs.resources.reviews.notes.fields.authorName
createdAtstringfacultatif
apiDocs.resources.reviews.notes.fields.createdAt
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/notes
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/deleteapiDocs.resources.reviews.notes.delete.summary

apiDocs.resources.reviews.notes.delete.description

apiDocs.resources.reviews.notes.delete.summary

delete/api/v1/reviews/notes
reviews:write
Paramètres de requête
reviewIdstringobligatoire
apiDocs.resources.reviews.notes.delete.paramsReviewId
noteIdstringobligatoire
apiDocs.resources.reviews.notes.delete.paramsNoteId
Réponse
dataobjectfacultatif
deletedbooleanfacultatif
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.
delete/api/v1/reviews/notes
Votre clé API
reviewId *
noteId *
{}
v1Ressources/Reviews/postapiDocs.resources.reviews.topicKeywords.post.summary

apiDocs.resources.reviews.topicKeywords.post.description

apiDocs.resources.reviews.topicKeywords.post.summary

post/api/v1/reviews/topic-trends/keywords
reviews:write
Corps de la requête
locationIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatoire
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Réponse
dataobjectfacultatif
customarray of stringfacultatif
apiDocs.resources.reviews.topicKeywords.fieldsCustom
queuedbooleanfacultatif
notestringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/topic-trends/keywords
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/deleteapiDocs.resources.reviews.topicKeywords.delete.summary

apiDocs.resources.reviews.topicKeywords.delete.description

apiDocs.resources.reviews.topicKeywords.delete.summary

delete/api/v1/reviews/topic-trends/keywords
reviews:write
Paramètres de requête
locationIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatoire
apiDocs.resources.reviews.topicKeywords.paramsKeyword
Réponse
dataobjectfacultatif
customarray of stringfacultatif
apiDocs.resources.reviews.topicKeywords.fieldsCustom
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.
delete/api/v1/reviews/topic-trends/keywords
Votre clé API
locationId
clientId
keyword *
{}
v1Ressources/Reviews/patchapiDocs.resources.reviews.topicKeywords.patch.summary

apiDocs.resources.reviews.topicKeywords.patch.description

apiDocs.resources.reviews.topicKeywords.patch.summary

patch/api/v1/reviews/topic-trends/keywords
reviews:write
Corps de la requête
locationIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsLocationId
clientIdstringfacultatif
apiDocs.resources.reviews.topicKeywords.paramsClientId
keywordstringobligatoire
apiDocs.resources.reviews.topicKeywords.paramsKeyword
hidebooleanobligatoire
apiDocs.resources.reviews.topicKeywords.paramsHide
Réponse
dataobjectfacultatif
customarray of stringfacultatif
apiDocs.resources.reviews.topicKeywords.fieldsCustom
hiddenarray of stringfacultatif
apiDocs.resources.reviews.topicKeywords.fieldsHidden
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.
patch/api/v1/reviews/topic-trends/keywords
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/getObtenir les tendances des sujets

Une série temporelle groupée par sujet d'avis, un classement, des mouvements ascendants/descendants, et des sujets émergents/en déclin — pour un emplacement.

Obtenir les tendances des sujets

get/api/v1/reviews/topic-trends
reviews:read
Paramètres de requête
locationIdstringobligatoire
clientIdstringobligatoire
windowDaysinteger (30 | 90 | 180)facultatif
Fenêtre de tendance en jours : 30, 90 ou 180. Par défaut 90.
Réponse
dataobjectfacultatif
Le contenu complet des Tendances de sujets.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/topic-trends
Votre clé API
locationId *
clientId *
windowDays
{}
v1Ressources/Reviews/getObtenir une série mensuelle plus longue d'un sujet

Une série mois par mois plus longue pour les sujets, au-delà de la fenêtre de tendance standard.

Obtenir une série mensuelle plus longue d'un sujet

get/api/v1/reviews/topic-trends/series
reviews:read
Paramètres de requête
locationIdstringobligatoire
clientIdstringobligatoire
monthsintegerfacultatif
Durée de la série en mois. Par défaut 12.
Réponse
dataobjectfacultatif
Le contenu complet de la série mensuelle de sujets.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/topic-trends/series
Votre clé API
locationId *
clientId *
months
{}
v1Ressources/Reviews/getObtenir les avis mentionnant un sujet

Explorer les avis qui mentionnent un sujet, éventuellement restreints à un mois.

Obtenir les avis mentionnant un sujet

get/api/v1/reviews/topic-trends/reviews
reviews:read
Paramètres de requête
locationIdstringobligatoire
clientIdstringobligatoire
topicstringobligatoire
Le sujet à consulter (depuis GET /api/v1/reviews/topic-trends).
monthstringfacultatif
Restreindre à une cellule de la heatmap (AAAA-MM). Omettre pour l'historique complet.
limitintegerfacultatif
Nombre maximal d'avis à renvoyer.
Réponse
dataobjectfacultatif
reviewsarray of objectfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/topic-trends/reviews
Votre clé API
locationId *
clientId *
topic *
month
limit
{}
v1Ressources/Reviews/getLister les widgets d'avis

Chaque widget d'avis configuré pour un emplacement.

Lister les widgets d'avis

get/api/v1/reviews/widgets
reviews:read
Paramètres de requête
locationIdstringobligatoire
clientIdstringobligatoire
Réponse
dataobjectfacultatif
widgetsarray of objectfacultatif
idstringfacultatif
agencyIdstringfacultatif
locationIdstringfacultatif
clientLocationIdstringfacultatif
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
createdAtstringfacultatif
updatedAtstringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/widgets
Votre clé API
locationId *
clientId *
{}
v1Ressources/Reviews/postCréer un widget d'avis

Crée un nouveau widget d'avis intégrable (badge de note + carrousel/liste d'avis) pour un emplacement.

Créer un widget d'avis

post/api/v1/reviews/widgets
reviews:write
Corps de la requête
locationIdstringobligatoire
clientIdstringobligatoire
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstring (30d | 90d | 1y | all)facultatif
countintegerfacultatif
includeInternalbooleanfacultatif
layoutstringfacultatif
statusstring (draft | published)facultatif
Réponse
dataobjectfacultatif
widgetobjectfacultatif
idstringfacultatif
agencyIdstringfacultatif
locationIdstringfacultatif
clientLocationIdstringfacultatif
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
createdAtstringfacultatif
updatedAtstringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/widgets
Votre clé API
Corps de la requête*
{}
v1Ressources/Reviews/getObtenir un widget d'avis

Renvoie la configuration complète d'un widget d'avis.

Obtenir un widget d'avis

get/api/v1/reviews/widgets/{id}
reviews:read
Paramètres de requête
idstringobligatoire
Réponse
dataobjectfacultatif
widgetobjectfacultatif
idstringfacultatif
agencyIdstringfacultatif
locationIdstringfacultatif
clientLocationIdstringfacultatif
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
createdAtstringfacultatif
updatedAtstringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/reviews/widgets/{id}
Votre clé API
id *
{}
v1Ressources/Reviews/patchMettre à jour un widget d'avis

Met à jour la configuration ou le design d'un widget (ou le publie, via status).

Mettre à jour un widget d'avis

patch/api/v1/reviews/widgets/{id}
reviews:write
Paramètres de requête
idstringobligatoire
Corps de la requête
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
Réponse
dataobjectfacultatif
widgetobjectfacultatif
idstringfacultatif
agencyIdstringfacultatif
locationIdstringfacultatif
clientLocationIdstringfacultatif
namestringfacultatif
minRatingintegerfacultatif
sourcesarray of stringfacultatif
selectionModestringfacultatif
dateWindowstringfacultatif
manualReviewIdsarray of stringfacultatif
countintegerfacultatif
includeInternalbooleanfacultatif
emojiPositiveRatingintegerfacultatif
layoutstringfacultatif
marqueeSpeedintegerfacultatif
themeobjectfacultatif
themeOverridesobjectfacultatif
showFlagsobjectfacultatif
statusstring (draft | published)facultatif
createdAtstringfacultatif
updatedAtstringfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
patch/api/v1/reviews/widgets/{id}
Votre clé API
id *
Corps de la requête
{}
v1Ressources/Reviews/deleteSupprimer un widget d'avis

Supprime définitivement un widget d'avis. Le widget intégré public cesse de fonctionner une fois supprimé.

Supprimer un widget d'avis

delete/api/v1/reviews/widgets/{id}
reviews:write
Paramètres de requête
idstringobligatoire
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
delete/api/v1/reviews/widgets/{id}
Votre clé API
id *
{}
v1Ressources/Reviews/postRépondre à un avis

Publie une réponse de l'entreprise à un avis et la transmet à la plateforme source. Échoue avec une erreur de règle métier (422) si l'avis ne peut pas recevoir de réponse — par ex. parce qu'il a été retiré de sa source.

Répondre à un avis

post/api/v1/reviews/reply
reviews:write
Corps de la requête
reviewIdstringobligatoire
L'avis auquel répondre. Obligatoire.
textstringobligatoire
Le texte de la réponse à publier. Obligatoire.
Réponse
dataobjectfacultatif
okbooleanfacultatif
Si la réponse a été acceptée.
pushedbooleanfacultatif
Si la réponse a réellement été transmise à la plateforme source (plutôt que mise en file d'attente).
statusstring (posted | pending | failed | draft)facultatif
L'une des valeurs : posted, pending, failed, draft.
externalReplyIdstringfacultatif
L'id de la réponse sur la plateforme source, ou null.
retryablebooleanfacultatif
En cas d'échec de la transmission, si une nouvelle tentative pourrait réussir — null si non applicable.
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/reviews/reply
Votre clé API
Corps de la requête*
{}