Passer au contenu principal
GET
/
api
/
external
/
v1
/
analytics
/
{projectId}
/
assistant
Récupérer les conversations de l’Assistant
curl --request GET \
  --url https://api.mintlify.com/api/external/v1/analytics/{projectId}/assistant \
  --header 'Authorization: Bearer <token>'
{
  "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 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
  • queryCategory : la classification du type de requête (si disponible)

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"

​
limit
number
défaut:100

Nombre maximal de résultats par page

Plage requise: 1 <= x <= 1000
​
cursor
string<ulid>

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