Obtenir des retours

Utilisez cet endpoint pour exporter les retours utilisateurs collectés à partir de votre documentation. Les retours incluent les commentaires contextuels issus des évaluations de pages, les retours sur les extraits de code et les retours des agents.

Parcourez les résultats à l’aide du paramètre cursor renvoyé dans la réponse. Continuez à effectuer des requêtes tant que hasMore vaut true.

Filtrez les feedbacks par :

• Plage de dates : utilisez dateFrom et dateTo pour limiter les résultats à une période donnée
• Source : filtrez par type de feedback, code_snippet, contextual ou agent
• Statut : filtrez par des valeurs de statut comme pending, in_progress, resolved ou dismissed

La réponse contient différents types de commentaires en fonction de la source :

• Commentaire contextuel : inclut le booléen helpful et éventuellement l’adresse e-mail contact
• Commentaire sur extrait de code : inclut les champs code, filename et lang
• Retour d’agent : inclut un comment avec le texte du retour de l’agent et le path de la page concernée

Cet endpoint autorise 100 requêtes par organisation et par heure. Tous les endpoints d’analytics partagent cette limite.