Obtenir les requêtes de recherche

Récupérez les termes de recherche de la documentation avec le nombre de requêtes, les taux de clics et les pages les plus cliquées.

GET /v1/analytics/{projectId}/searches

Obtenir les requetes de recherche

cURL

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

200

{
  "searches": [
    {
      "searchQuery": "<string>",
      "hits": 123,
      "ctr": 123,
      "topClickedPage": "<string>",
      "lastSearchedAt": "<string>"
    }
  ],
  "totalSearches": 1,
  "nextCursor": "<string>"
}

​

Utilisation

Utilisez cet endpoint pour exporter les données analytiques de recherche de votre documentation. Les résultats sont classés par nombre de requêtes décroissant, montrant les termes les plus recherchés par vos utilisateurs.

Parcourez les résultats à l’aide du paramètre nextCursor renvoyé dans la réponse. Continuez à récupérer les données tant que nextCursor n’est pas null.

​

Filtrage

Filtrez les données de recherche par plage de dates à l’aide des paramètres dateFrom et dateTo.

​

Données de la réponse

Chaque entrée de terme de recherche inclut :

• searchQuery : le terme de recherche saisi par les utilisateurs
• hits : nombre de fois que ce terme a été recherché
• ctr : taux de clics pour ce terme de recherche
• topClickedPage : le chemin du résultat le plus cliqué pour cette requête, le cas échéant
• lastSearchedAt : horodatage de la dernière recherche de ce terme

La réponse inclut également totalSearches, qui correspond au nombre total d’événements de recherche dans la période demandée (somme de tous les hits, pas le nombre de requêtes distinctes).

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: 50

Nombre maximal de termes par page

Plage requise: 1 <= x <= 100

cursor · string

Curseur de pagination opaque

Réponse

200

application/json

Agregats de termes de recherche

searches · object[] · requis

Search terms ordered by hit count descending.

Show child attributes

totalSearches · integer · requis

Total count of search events in the requested date range.

Plage requise: x >= 0

nextCursor · string | null · requis

Opaque pagination cursor for the next page. Null if no more results.