API

Obtenir l’analytique des avis

GET/api/crm/v2/feedback_analyticsv2
operationId: feedbackAnalytics.default

Retourne des tuiles récapitulatives et un graphique des avis pour la période spécifiée. Chaque point correspond à une heure en UTC ; seuls les points non vides sont retournés. L’interface convertit automatiquement l’heure dans le fuseau horaire de l’utilisateur et regroupe les heures par jour. La période par défaut est aujourd’hui. La période est limitée à un an ; une période plus longue est tronquée à partir des dates les plus récentes. La tuile de part contient dynamics — la variation par rapport à date_comparison_*. Si cette période n’est pas définie, la période de même durée précédant immédiatement la période sélectionnée est utilisée par défaut. Cette valeur par défaut s’applique uniquement à la comparaison et n’est pas retournée dans les filtres.

Autorisation

api-token + language + role

Paramètres de requête

date_fromstring

Exemple: 25/04/2024

date_tostring

Exemple: 26/04/2024

date_comparison_fromstring

Exemple: 25/03/2024

date_comparison_tostring

Exemple: 26/03/2024

chain_idinteger

Exemple: 1

branch_idinteger

Exemple: 1

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_rangeobject (FilterDateRange)

Périodes prédéfinies pour le filtre de date ; la limite inférieure est calculée selon le fuseau horaire de l'utilisateur. value — période correspondant aux valeurs actuelles de *_from et *_to ; null — période personnalisée. default — période que le serveur applique à une requête sans dates : elle est également utilisée lors du premier chargement de la section et lors de la réinitialisation. La limite supérieure de la période correspond toujours au jour actuel de l'utilisateur, c'est pourquoi option ne la contient pas : il n'est pas nécessaire de transmettre *_to pour une période prédéfinie, le serveur la définit automatiquement. Une période de plus d'un an est tronquée du côté de la limite la plus récente.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

date_comparison_fromobject (FilterDateFrom)
valuestringpeut être nul

Exemple: 2026-08-01 00:00:00

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_comparison_toobject (FilterDateTo)
valuestringpeut être nul

Exemple: 2026-08-31 23:59:59

typestringobligatoire

Exemple: date

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

date_comparison_rangeobject (FilterDateRangeOptional)

Périodes prédéfinies pour le filtre de dates sans valeur par défaut : default est toujours égal à null.

valuestring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

defaultstring (DateRange) peut être nul

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

typestringobligatoire

Exemple: select

optionarray of objectobligatoire
valuestring (DateRange) obligatoire

Période de filtre de date prédéfinie. Ce schéma n'a pas de paramètre de requête propre : la limite inférieure est déjà calculée dans option et utilisée dans *_from. La limite supérieure n'est transmise ni dans la réponse, ni dans la requête — elle correspond toujours au jour actuel de l'utilisateur et est définie par le serveur.

Valeurs:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Exemple: today

date_fromstringobligatoire

Exemple: 25/08/2026

chain_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

branch_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

tilesobject
totalobject (FeedbackAnalyticsCountTile) obligatoire

Tuile-compteur dans la ligne de synthèse : nombre d'avis et leur part pour la période. percent est égal à null s'il n'y a aucun avis sur la période. L'évolution par rapport à la période de comparaison n'est pas transmise intentionnellement : le nombre d'avis dépend du trafic, donc sa croissance n'indique rien sur la qualité.

valueintegerobligatoire

Exemple: 96

percentnumber · float

Exemple: 75

positiveobject (FeedbackAnalyticsCountTile) obligatoire

Tuile-compteur dans la ligne de synthèse : nombre d'avis et leur part pour la période. percent est égal à null s'il n'y a aucun avis sur la période. L'évolution par rapport à la période de comparaison n'est pas transmise intentionnellement : le nombre d'avis dépend du trafic, donc sa croissance n'indique rien sur la qualité.

valueintegerobligatoire

Exemple: 96

percentnumber · float

Exemple: 75

negativeobject (FeedbackAnalyticsCountTile) obligatoire

Tuile-compteur dans la ligne de synthèse : nombre d'avis et leur part pour la période. percent est égal à null s'il n'y a aucun avis sur la période. L'évolution par rapport à la période de comparaison n'est pas transmise intentionnellement : le nombre d'avis dépend du trafic, donc sa croissance n'indique rien sur la qualité.

valueintegerobligatoire

Exemple: 96

percentnumber · float

Exemple: 75

positive_shareobject (FeedbackAnalyticsShareTile) obligatoire

Tuile de part dans la ligne récapitulative. Contrairement aux compteurs, elle contient dynamics — variation de la part par rapport à la période de comparaison, en points de pourcentage ; elle ne dépend pas du trafic. percent et dynamics sont à null s'il n'y a rien à diviser : absence d'avis pour la période ou pour la période de comparaison.

valueintegerobligatoire

Exemple: 96

percentnumber · float

Exemple: 75

dynamicsnumber · float

Exemple: -0.2

pointsarray of object
datetimestringobligatoire

Début du point horaire en UTC

Exemple: 2026-09-08 10:00:00

positiveintegerobligatoire

Exemple: 3

negativeintegerobligatoire

Exemple: 1