Skip to main content
GET
Récupérer les conversations de l’Assistant

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 ligne représente un tour de l’utilisateur dans une conversation. Une conversation comportant plusieurs échanges produit plusieurs lignes qui partagent le même conversationId. Chaque ligne comprend :
  • query : la question de l’utilisateur.
  • response : la réponse de l’Assistant. Pour les tours de question de clarification, il s’agit de la question de suivi que l’Assistant a posée à l’utilisateur.
  • responseType : answer ou clarifying_question. clarifying_question signifie que l’Assistant a posé une question de suivi au lieu de répondre. La valeur par défaut est answer lorsque le champ est absent.
  • 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 à ce tour. La valeur est answered ou unanswered. Elle est calculée par ligne, une même conversation peut donc contenir les deux statuts. 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.
  • timestamp : le moment où l’utilisateur a envoyé le message qui a lancé ce tour. Les lignes d’une même conversation ont des horodatages différents.
  • queryCategory : la classification du type de requête, si disponible.
  • pageUrl : URL complète de la page de documentation où la conversation a démarré, ou null si aucun chemin de page n’est disponible. Utilisez ce champ pour attribuer les conversations à une page spécifique.

Limites de débit

Cet endpoint autorise 100 requêtes par organisation et par heure. Tous les endpoints d’analytics partagent cette limite.

Autorisations

Authorization
string
header
requis

L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la page des clés d'API de 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

Données de conversation paginées

conversations
object[]
requis

Liste des conversations de l’Assistant.

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.