mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
69cdff9efd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
36 lines
1.6 KiB
Plaintext
36 lines
1.6 KiB
Plaintext
---
|
||
title: "Obtenir des retours"
|
||
description: "Récupérez les retours des utilisateurs sur votre documentation,
|
||
notamment les notes des pages et les commentaires sur les extraits de code."
|
||
openapi: /fr/analytics.openapi.json GET /v1/analytics/{projectId}/feedback
|
||
keywords: [ "analytics", "feedback", "export", "feedback utilisateur" ]
|
||
---
|
||
|
||
<div id="usage">
|
||
## Utilisation
|
||
</div>
|
||
|
||
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`.
|
||
|
||
<div id="filtering">
|
||
## Filtrage
|
||
</div>
|
||
|
||
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`
|
||
|
||
<div id="response-types">
|
||
## Types de réponse
|
||
</div>
|
||
|
||
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
|