Obtenir des retours

Récupérez les retours des utilisateurs sur votre documentation, notamment les notes des pages et les commentaires sur les extraits de code.

GET /v1/analytics/{projectId}/feedback

Récupérer les retours des utilisateurs

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'

200

{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "helpful": true,
      "contact": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​

Utilisation

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.

​

Filtrage

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

​

Types de réponse

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

Autorisations

Authorization · string · header · requis

L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API administrateur (préfixée par mint_). Il s’agit d’une clé secrète côté serveur. Générez-en une depuis la page API keys dans votre Dashboard.

Paramètres de chemin

projectId · string · requis

ID de votre projet. Vous pouvez le copier depuis la page API keys de votre Dashboard.

Paramètres de requête

dateFrom · string

Date au format ISO 8601 ou AAAA-MM-JJ

Exemple:

"2024-01-01"

dateTo · string

Date au format ISO 8601 ou AAAA-MM-JJ. dateTo est une borne supérieure exclusive. Les résultats incluent les dates antérieures, mais pas la date spécifiée elle-même.

Exemple:

"2024-01-01"

source · enum<string>

Filtrer par source des retours utilisateurs

Options disponibles: code_snippet, contextual, agent, thumbs_only

status · string

Liste de statuts séparés par des virgules pour le filtrage

limit · number · défaut: 50

Nombre maximal de résultats par page

Plage requise: 1 <= x <= 100

cursor · string

Curseur de pagination

Réponse

200

application/json

Données de retours utilisateurs paginées

feedback · object[] · requis

Liste des retours.

Renvoyé lorsque la source est contextual. Indique si l'utilisateur a trouvé la page utile et un e-mail de contact optionnel.

Option 1

Option 2

Option 3

Show child attributes

nextCursor · string | null · requis

Curseur permettant de récupérer la page de résultats suivante. null s’il n’y a plus de résultats.

hasMore · boolean · requis

Indique si des résultats supplémentaires sont disponibles au-delà de cette page.