mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
be2090200f
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
147 lines
4.9 KiB
Plaintext
147 lines
4.9 KiB
Plaintext
---
|
|
title: "Analysez votre documentation"
|
|
description: "Consultez le trafic, les requêtes de recherche, les retours et les conversations de l'assistant depuis le terminal avec la CLI Mintlify."
|
|
keywords: ["mint analytics", "analytique", "CLI", "statistiques", "retours", "conversations"]
|
|
---
|
|
|
|
La commande `mint analytics` vous donne accès aux [analytiques de votre documentation](/fr/optimize/analytics) 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.
|
|
|
|
<div id="prerequisites">
|
|
## Prérequis
|
|
</div>
|
|
|
|
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](/fr/cli/preview#log-in-for-search-and-assistant) pour plus de détails sur l'authentification.
|
|
|
|
<div id="view-key-metrics">
|
|
## Consulter les métriques clés
|
|
</div>
|
|
|
|
Affichez un résumé des vues, visiteurs, recherches, retours et utilisation de l'assistant :
|
|
|
|
```bash
|
|
mint analytics stats
|
|
```
|
|
|
|
Utilisez des flags pour filtrer par plage de dates, page ou source de trafic :
|
|
|
|
- `--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.
|
|
- `--humans` : Afficher uniquement le trafic humain.
|
|
- `--agents` : Afficher uniquement le trafic IA.
|
|
|
|
```bash Example analytics stats flags
|
|
mint analytics stats --from 2025-01-01 --to 2025-01-31
|
|
mint analytics stats --page /quickstart
|
|
mint analytics stats --humans
|
|
mint analytics stats --agents
|
|
```
|
|
|
|
<div id="view-search-analytics">
|
|
## Consulter les analytiques de recherche
|
|
</div>
|
|
|
|
Consultez ce que vos utilisateurs recherchent, avec le nombre de résultats et les taux de clics :
|
|
|
|
```bash
|
|
mint analytics search
|
|
```
|
|
|
|
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.
|
|
|
|
```bash Example analytics search flags
|
|
mint analytics search --query "authentication"
|
|
|
|
mint analytics search --page /api-reference
|
|
```
|
|
|
|
<div id="view-feedback">
|
|
## Consulter les retours
|
|
</div>
|
|
|
|
Consultez les retours soumis par les utilisateurs sur les pages de votre documentation :
|
|
|
|
```bash
|
|
mint analytics feedback
|
|
```
|
|
|
|
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.
|
|
|
|
```bash Example analytics feedback flags
|
|
mint analytics feedback --type page
|
|
mint analytics feedback --type code
|
|
```
|
|
|
|
<div id="view-assistant-conversations">
|
|
## Consulter les conversations de l'assistant
|
|
</div>
|
|
|
|
Listez les conversations récentes et les catégories de conversations de l'assistant IA :
|
|
|
|
```bash
|
|
mint analytics conversation list
|
|
mint analytics conversation buckets list
|
|
```
|
|
|
|
Chaque liste inclut un ID pour chaque entrée. Transmettez cet ID à la commande `view` correspondante pour voir les détails complets :
|
|
|
|
```bash
|
|
mint analytics conversation view <conversation-id>
|
|
mint analytics conversation buckets view <bucket-id>
|
|
```
|
|
|
|
<div id="choose-an-output-format">
|
|
## Choisir un format de sortie
|
|
</div>
|
|
|
|
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 :
|
|
|
|
```bash
|
|
mint analytics stats --format table # Tableau mis en forme avec couleurs
|
|
mint analytics stats --format json # JSON brut
|
|
mint analytics stats --format graph # Graphique à barres horizontal
|
|
```
|
|
|
|
Utilisez le flag `--agent` pour obtenir une sortie JSON. La CLI détecte automatiquement les environnements d'agent lorsque la variable d'environnement `CLAUDECODE` est définie à `1`.
|
|
|
|
<div id="set-defaults-with-config">
|
|
## Définir des valeurs par défaut avec config
|
|
</div>
|
|
|
|
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`.
|
|
|
|
Clés de configuration disponibles :
|
|
|
|
| Clé | Description |
|
|
| --- | --- |
|
|
| `subdomain` | Sous-domaine par défaut pour les commandes d'analytique. |
|
|
| `dateFrom` | Date de début par défaut pour les requêtes d'analytique (`YYYY-MM-DD`). |
|
|
| `dateTo` | Date de fin par défaut pour les requêtes d'analytique (`YYYY-MM-DD`). |
|
|
|
|
```bash Example configs
|
|
mint config set subdomain my-docs
|
|
mint config set dateFrom 2025-01-01
|
|
```
|
|
|
|
Une fois définis, les commandes d'analytique utilisent automatiquement ces valeurs :
|
|
|
|
```bash
|
|
# Utilise le sous-domaine et dateFrom configurés sans flags
|
|
mint analytics stats
|
|
```
|
|
|
|
Pour consulter ou effacer une valeur, exécutez :
|
|
|
|
```bash
|
|
mint config get subdomain
|
|
mint config clear subdomain
|
|
```
|