Passer au contenu principal
La commande mint analytics vous donne accès aux analytiques de votre documentation depuis le terminal. Cela est utile pour générer des rapports d’analytique via des scripts, acheminer des données vers d’autres outils et effectuer des vérifications rapides sans ouvrir le tableau de bord.

Prérequis

Vous devez vous connecter pour utiliser les commandes d’analytique. Exécutez mint login pour vous authentifier avec votre compte Mintlify. Consultez Prévisualisation locale pour plus de détails sur l’authentification.

Consulter les métriques clés

Affichez un résumé des vues, visiteurs, recherches, retours et utilisation de l’assistant :
Utilisez des flags pour filtrer par plage de dates ou page :
  • --from : Date de début au format YYYY-MM-DD. Par défaut, 7 jours en arrière.
  • --to : Date de fin au format YYYY-MM-DD. Par défaut, aujourd’hui.
  • --page : Filtrer sur une page spécifique.
Example analytics stats flags

Consulter les analytiques de recherche

Consultez ce que vos utilisateurs recherchent, avec le nombre de résultats et les taux de clics :
Utilisez des flags pour filtrer par chaîne de recherche ou par page :
  • --query : Filtrer par sous-chaîne de requête de recherche.
  • --page : Filtrer sur une page spécifique.
Example analytics search flags

Consulter les retours

Consultez les retours soumis par les utilisateurs sur les pages de votre documentation :
Utilisez des flags pour agréger les retours par page ou filtrer par retours de code :
  • --type : Agréger les retours par page ou extrait de code. Par défaut, page.
  • --page : Filtrer sur une page spécifique.
Example analytics feedback flags

Consulter les conversations de l’assistant

Listez les conversations récentes et les catégories de conversations de l’assistant IA :
Chaque liste inclut un ID pour chaque entrée. Transmettez cet ID à la commande view correspondante pour voir les détails complets :

Choisir un format de sortie

Toutes les commandes d’analytique utilisent par défaut la sortie plain, séparée par des tabulations et adaptée à l’acheminement vers d’autres outils. Utilisez --format pour modifier la sortie :
La CLI détecte automatiquement les environnements d’agents IA comme Claude Code ou les terminaux non interactifs et utilise par défaut la sortie JSON.

Définir des valeurs par défaut avec config

Pour éviter de répéter les flags courants, définissez des valeurs par défaut avec mint config. La configuration est enregistrée dans ~/.config/mintlify/config.json. Lorsque vous exécutez mint login, la CLI définit la clé subdomain. Si vous avez plusieurs déploiements, la CLI vous invite à en choisir un. Vous pouvez modifier la valeur par défaut à tout moment avec mint config set subdomain <subdomain>. Clés de configuration disponibles :
Example configs
Une fois définis, les commandes d’analytique utilisent automatiquement ces valeurs :
Pour consulter ou effacer une valeur, exécutez :