Obtenir les retours par page

Récupérez les décomptes de retours agrégés par page de documentation, y compris les évaluations pouces en haut/bas et les retours sur les extraits de code.

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

Obtenir les retours groupés 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 obtenir un aperçu du volume de retours sur les pages de votre documentation. Les résultats sont agrégés par chemin de page et triés par nombre total de retours par ordre décroissant.

Vérifiez le champ hasMore dans la réponse pour déterminer si des pages de résultats supplémentaires sont disponibles. Augmentez le paramètre limit pour récupérer davantage de résultats par requête.

​

Filtrage

Filtrez les agrégats de retours 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

​

Champs de la réponse

Chaque élément de la réponse représente une page de documentation et inclut :

• thumbsUp : Nombre d’évaluations contextuelles positives (utile)
• thumbsDown : Nombre d’évaluations contextuelles négatives (pas utile)
• code : Nombre de retours sur les extraits de code
• total : Nombre combiné de tous les types 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

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

status · string

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

limit · number · défaut: 10

Nombre maximal de résultats par page

Plage requise: 1 <= x <= 100

Réponse

200

application/json

Agrégats de retours par page avec indicateur de pagination

feedback · object[] · requis

Liste des agrégats de retours par page.

Show child attributes

hasMore · boolean · requis

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