Obtenir les retours par page

Récupérez les comptages de retours utilisateurs agrégés par page de documentation, incluant les évaluations pouce levé/baissé et les retours sur les extraits de code.

GET /v1/analytics/{projectId}/feedback/by-page

Obtenir les retours par page

cURL

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

200

{
  "feedback": [
    {
      "path": "<string>",
      "thumbsUp": 123,
      "thumbsDown": 123,
      "code": 123,
      "total": 123
    }
  ],
  "hasMore": true
}

​

Utilisation

Utilisez cet endpoint pour exporter les retours utilisateurs agrégés par chemin de page de documentation. Chaque entrée affiche le nombre total de retours pour une page, ventilé par type.

Parcourez les résultats à l’aide de l’indicateur hasMore dans la réponse.

​

Filtrage

Filtrez les retours par :

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

​

Données de la réponse

Chaque entrée de page inclut :

• path : le chemin de la page de documentation
• thumbsUp : nombre de retours contextuels positifs
• thumbsDown : nombre de retours contextuels négatifs
• code : nombre de retours sur des extraits de code
• total : nombre total de retours pour la page

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

Borne superieure exclusive

Exemple:

"2024-01-01"

limit · number · défaut: 10

Nombre maximal de resultats par page

Plage requise: 1 <= x <= 100

source · enum<string>

Filtrer par source des retours

Options disponibles: code_snippet, contextual

status · string

Statuts separes par des virgules

Réponse

200

application/json

Agregats de retours par page

feedback · object[] · requis

Feedback counts aggregated by documentation page path.

Show child attributes

hasMore · boolean · requis

Whether additional results are available beyond this page.