Passer au contenu principal
GET
/
api
/
external
/
v1
/
analytics
/
{projectId}
/
feedback
Obtenir les retours utilisateurs
curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/feedback \
  --header 'Authorization: Bearer <token>'
{
  "feedback": [
    {
      "id": "<string>",
      "path": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "source": "code_snippet",
      "status": "pending"
    }
  ],
  "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 et les retours sur les extraits de code. 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 ou contextual
  • 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

Autorisations

​
Authorization
string
header
requis

L’en-tête Authorization doit contenir un jeton Bearer. Consultez la documentation Authentification de l’API pour savoir comment obtenir votre clé d’API.

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

Exemple:

"2024-01-01"

​
source
enum<string>

Filtrer par source des commentaires

Options disponibles:
code_snippet,
contextual
​
status
string

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

​
limit
number
défaut:50

Nombre maximal de résultats à renvoyer par page

Plage requise: 1 <= x <= 100
​
cursor
string

Curseur de pagination

Réponse

Données de commentaires paginées

​
feedback
object[]
requis

Liste des retours.

​
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.