Récupérer les conversations de l'Assistant

Renvoie l’historique de conversation paginé de l’Assistant IA

GET /v1/analytics/{projectId}/assistant

Récupérer les conversations de l’Assistant

cURL

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

200

{
  "conversations": [
    {
      "id": "<string>",
      "timestamp": "<string>",
      "query": "<string>",
      "response": "<string>",
      "sources": [
        {
          "title": "<string>",
          "url": "<string>"
        }
      ],
      "queryCategory": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": true
}

​

Utilisation

Utilisez cet endpoint pour exporter l’historique des conversations de l’Assistant IA à partir de votre documentation. Chaque conversation inclut la requête de l’utilisateur, la réponse de l’Assistant IA, les sources citées, le statut de résolution et la catégorie de la requête.

Parcourez les résultats à l’aide du paramètre cursor renvoyé dans la réponse. Continuez à récupérer les données tant que hasMore vaut true.

​

Filtrage

Filtrez les conversations par plage de dates à l’aide des paramètres dateFrom et dateTo.

​

Données de conversation

Chaque conversation comprend :

• query : la question de l’utilisateur
• response : la réponse de l’Assistant
• sources : les pages référencées dans la réponse, avec leur title et leur URL
• resolutionStatus : indique si l’Assistant a répondu correctement à la question. La valeur est answered ou unanswered. Utilisez ce champ pour suivre et analyser les lacunes de la documentation mises en évidence par les questions des utilisateurs auxquelles l’Assistant n’a pas pu répondre.
• queryCategory : la classification du type de requête (si disponible)

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.

Exemple:

"2024-01-01"

limit · number · défaut: 100

Nombre maximal de résultats par page

Plage requise: 1 <= x <= 1000

cursor · string<ulid>

Curseur de pagination (format ULID)

Réponse

200

application/json

Données de conversation paginées

conversations · object[] · requis

Liste des conversations de l’Assistant.

Show child attributes

nextCursor · string | null · requis

Curseur de pagination 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.