diff --git a/cli/commands.mdx b/cli/commands.mdx index 2c5623e82..404f142a0 100644 --- a/cli/commands.mdx +++ b/cli/commands.mdx @@ -326,6 +326,132 @@ mint automations delete [flags] --- +## `mint analytics` + +Query documentation analytics from the terminal. Requires authentication with `mint login`. + +```bash +mint analytics [flags] +``` + +All subcommands accept these shared flags: + +| Flag | Description | +| --- | --- | +| `--subdomain` | Documentation subdomain. Defaults to the value set with `mint config set subdomain`, or the first project on your account. | +| `--from` | Start date in `YYYY-MM-DD` format. Defaults to seven days ago, or the value set with `mint config set dateFrom`. | +| `--to` | End date in `YYYY-MM-DD` format. Defaults to today, or the value set with `mint config set dateTo`. | +| `--format` | Output format: `table` (pretty), `plain` (tab-separated, pipeable), `json` (raw), or `graph` (bar chart). Defaults to `plain`, or `json` when the CLI detects an AI or CI environment. | + +### `mint analytics stats` + +Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. Human and agent traffic are reported separately. + +```bash +mint analytics stats [flags] +``` + +| Flag | Description | +| --- | --- | +| `--page` | Filter to a specific page path. | + +### `mint analytics search` + +Display search queries with hit counts, click-through rates, top clicked page, and last searched date. + +```bash +mint analytics search [flags] +``` + +| Flag | Description | +| --- | --- | +| `--query` | Filter results by search query substring. | +| `--page` | Filter results to queries where the given page was the top clicked result. | + +### `mint analytics feedback` + +Display feedback submitted by users. By default, returns individual feedback entries. Pass `--type page` to see feedback aggregated by page path, or `--type code` to only include feedback on code snippets. + +```bash +mint analytics feedback [flags] +``` + +| Flag | Description | +| --- | --- | +| `--type` | `code` for code snippet feedback, or `page` for page-level aggregation. Omit for all feedback entries. | +| `--page` | Filter to a specific page path. | + +### `mint analytics conversation` + +View assistant conversation analytics. + +#### `mint analytics conversation list` + +List recent assistant conversations with timestamp, first user query, and category. + +```bash +mint analytics conversation list [flags] +``` + +| Flag | Description | +| --- | --- | +| `--page` | Filter to conversations whose sources reference the given page path. | + +#### `mint analytics conversation view` + +View the full message thread for a single conversation. + +```bash +mint analytics conversation view [flags] +``` + +| Argument | Description | +| --- | --- | +| `id` | Conversation ID from `mint analytics conversation list`. | + +#### `mint analytics conversation buckets list` + +List clusters of conversations grouped by topic, with the number of conversations and the most recent question date for each cluster. + +```bash +mint analytics conversation buckets list [flags] +``` + +#### `mint analytics conversation buckets view` + +List the individual threads in a conversation bucket. + +```bash +mint analytics conversation buckets view [flags] +``` + +| Argument | Description | +| --- | --- | +| `id` | Bucket ID from `mint analytics conversation buckets list`. | + +| Flag | Description | +| --- | --- | +| `--limit` | Maximum threads to return. Between 1 and 100. | +| `--cursor` | Pagination cursor from a previous response. | + +#### Examples + +```bash +# KPIs for the last 30 days +mint analytics stats --from 2026-07-25 --to 2026-08-24 + +# Top search queries as a bar chart +mint analytics search --format graph + +# Page-level feedback aggregated as JSON for piping into other tools +mint analytics feedback --type page --format json + +# View a single conversation thread +mint analytics conversation view conv_123 +``` + +--- + ## `mint config` Manage persistent default values for CLI commands. The configuration saves in `~/.config/mintlify/config.json`. diff --git a/es/cli/commands.mdx b/es/cli/commands.mdx index fa4e2021d..fb7ffb0f2 100644 --- a/es/cli/commands.mdx +++ b/es/cli/commands.mdx @@ -362,6 +362,152 @@ mint automations delete [flags] --- +
+ ## `mint analytics` +
+ +Consulta las analíticas de la documentación desde la terminal. Requiere autenticación con `mint login`. + +```bash +mint analytics [flags] +``` + +Todos los subcomandos aceptan estos flags compartidos: + +| Flag | Descripción | +| --- | --- | +| `--subdomain` | Subdominio de la documentación. Por defecto usa el valor establecido con `mint config set subdomain`, o el primer proyecto de tu cuenta. | +| `--from` | Fecha de inicio en formato `YYYY-MM-DD`. Por defecto, hace siete días, o el valor establecido con `mint config set dateFrom`. | +| `--to` | Fecha de fin en formato `YYYY-MM-DD`. Por defecto, hoy, o el valor establecido con `mint config set dateTo`. | +| `--format` | Formato de salida: `table` (formato legible), `plain` (separado por tabulaciones, canalizable), `json` (sin procesar) o `graph` (gráfico de barras). Por defecto, `plain`, o `json` cuando la CLI detecta un entorno de IA o CI. | + +
+ ### `mint analytics stats` +
+ +Muestra los KPIs principales para un rango de fechas: vistas, visitantes, búsquedas, feedback y uso del asistente. El tráfico humano y el de agentes se reportan por separado. + +```bash +mint analytics stats [flags] +``` + +| Flag | Descripción | +| --- | --- | +| `--page` | Filtrar por una ruta de página específica. | + + + +Muestra las consultas de búsqueda con el número de resultados, la tasa de clics, la página más clicada y la fecha de la última búsqueda. + +```bash +mint analytics search [flags] +``` + +| Flag | Descripción | +| --- | --- | +| `--query` | Filtra los resultados por una subcadena de la consulta de búsqueda. | +| `--page` | Filtra los resultados a las consultas en las que la página dada fue el resultado más clicado. | + +
+ ### `mint analytics feedback` +
+ +Muestra el feedback enviado por los usuarios. Por defecto, devuelve entradas individuales de feedback. Pasa `--type page` para ver el feedback agregado por ruta de página, o `--type code` para incluir solo el feedback sobre fragmentos de código. + +```bash +mint analytics feedback [flags] +``` + +| Flag | Descripción | +| --- | --- | +| `--type` | `code` para feedback sobre fragmentos de código, o `page` para agregación a nivel de página. Omítelo para todas las entradas de feedback. | +| `--page` | Filtrar por una ruta de página específica. | + +
+ ### `mint analytics conversation` +
+ +Consulta las analíticas de las conversaciones del asistente. + +
+ #### `mint analytics conversation list` +
+ +Lista las conversaciones recientes del asistente con marca de tiempo, primera consulta del usuario y categoría. + +```bash +mint analytics conversation list [flags] +``` + +| Flag | Descripción | +| --- | --- | +| `--page` | Filtrar a las conversaciones cuyas fuentes hagan referencia a la ruta de página dada. | + +
+ #### `mint analytics conversation view` +
+ +Consulta el hilo completo de mensajes de una sola conversación. + +```bash +mint analytics conversation view [flags] +``` + +| Argumento | Descripción | +| --- | --- | +| `id` | ID de la conversación obtenido de `mint analytics conversation list`. | + +
+ #### `mint analytics conversation buckets list` +
+ +Lista los clústeres de conversaciones agrupadas por tema, con el número de conversaciones y la fecha de la pregunta más reciente para cada clúster. + +```bash +mint analytics conversation buckets list [flags] +``` + +
+ #### `mint analytics conversation buckets view` +
+ +Lista los hilos individuales de un bucket de conversaciones. + +```bash +mint analytics conversation buckets view [flags] +``` + +| Argumento | Descripción | +| --- | --- | +| `id` | ID del bucket obtenido de `mint analytics conversation buckets list`. | + +| Flag | Descripción | +| --- | --- | +| `--limit` | Número máximo de hilos a devolver. Entre 1 y 100. | +| `--cursor` | Cursor de paginación de una respuesta anterior. | + +
+ #### Ejemplos +
+ +```bash +# KPIs de los últimos 30 días +mint analytics stats --from 2026-07-25 --to 2026-08-24 + +# Principales consultas de búsqueda en un gráfico de barras +mint analytics search --format graph + +# Feedback a nivel de página agregado en JSON para canalizar a otras herramientas +mint analytics feedback --type page --format json + +# Consulta un único hilo de conversación +mint analytics conversation view conv_123 +``` + +--- +
## `mint config`
diff --git a/fr/cli/commands.mdx b/fr/cli/commands.mdx index 369e6d660..3cb771f2e 100644 --- a/fr/cli/commands.mdx +++ b/fr/cli/commands.mdx @@ -364,6 +364,152 @@ mint automations delete [flags] --- +
+ ## `mint analytics` +
+ +Interrogez les analytics de la documentation depuis le terminal. Nécessite une authentification avec `mint login`. + +```bash +mint analytics [flags] +``` + +Tous les sous-commandes acceptent ces flags partagés : + +| Flag | Description | +| --- | --- | +| `--subdomain` | Sous-domaine de la documentation. Par défaut, utilise la valeur définie avec `mint config set subdomain`, ou le premier projet de votre compte. | +| `--from` | Date de début au format `YYYY-MM-DD`. Par défaut, sept jours en arrière, ou la valeur définie avec `mint config set dateFrom`. | +| `--to` | Date de fin au format `YYYY-MM-DD`. Par défaut, aujourd'hui, ou la valeur définie avec `mint config set dateTo`. | +| `--format` | Format de sortie : `table` (lisible), `plain` (séparé par des tabulations, redirigeable), `json` (brut) ou `graph` (graphique à barres). Par défaut, `plain`, ou `json` lorsque la CLI détecte un environnement d'IA ou de CI. | + +
+ ### `mint analytics stats` +
+ +Affiche les KPI principaux pour une plage de dates : vues, visiteurs, recherches, retours et utilisation de l'assistant. Le trafic humain et le trafic des agents sont rapportés séparément. + +```bash +mint analytics stats [flags] +``` + +| Flag | Description | +| --- | --- | +| `--page` | Filtrer sur un chemin de page spécifique. | + + + +Affiche les requêtes de recherche avec le nombre de résultats, les taux de clics, la page la plus cliquée et la date de la dernière recherche. + +```bash +mint analytics search [flags] +``` + +| Flag | Description | +| --- | --- | +| `--query` | Filtrer les résultats par sous-chaîne de la requête de recherche. | +| `--page` | Filtrer les résultats aux requêtes où la page donnée était le résultat le plus cliqué. | + +
+ ### `mint analytics feedback` +
+ +Affiche les retours soumis par les utilisateurs. Par défaut, renvoie les entrées de retour individuelles. Passez `--type page` pour voir les retours agrégés par chemin de page, ou `--type code` pour n'inclure que les retours sur les extraits de code. + +```bash +mint analytics feedback [flags] +``` + +| Flag | Description | +| --- | --- | +| `--type` | `code` pour les retours sur les extraits de code, ou `page` pour l'agrégation au niveau de la page. Omettez pour toutes les entrées de retour. | +| `--page` | Filtrer sur un chemin de page spécifique. | + +
+ ### `mint analytics conversation` +
+ +Consultez les analytics des conversations de l'assistant. + +
+ #### `mint analytics conversation list` +
+ +Liste les conversations récentes de l'assistant avec l'horodatage, la première requête utilisateur et la catégorie. + +```bash +mint analytics conversation list [flags] +``` + +| Flag | Description | +| --- | --- | +| `--page` | Filtrer sur les conversations dont les sources font référence au chemin de page donné. | + +
+ #### `mint analytics conversation view` +
+ +Affiche le fil de messages complet pour une seule conversation. + +```bash +mint analytics conversation view [flags] +``` + +| Argument | Description | +| --- | --- | +| `id` | ID de la conversation obtenu via `mint analytics conversation list`. | + +
+ #### `mint analytics conversation buckets list` +
+ +Liste les clusters de conversations regroupées par sujet, avec le nombre de conversations et la date de la question la plus récente pour chaque cluster. + +```bash +mint analytics conversation buckets list [flags] +``` + +
+ #### `mint analytics conversation buckets view` +
+ +Liste les fils individuels d'un bucket de conversations. + +```bash +mint analytics conversation buckets view [flags] +``` + +| Argument | Description | +| --- | --- | +| `id` | ID du bucket obtenu via `mint analytics conversation buckets list`. | + +| Flag | Description | +| --- | --- | +| `--limit` | Nombre maximum de fils à retourner. Entre 1 et 100. | +| `--cursor` | Curseur de pagination provenant d'une réponse précédente. | + +
+ #### Exemples +
+ +```bash +# KPI des 30 derniers jours +mint analytics stats --from 2026-07-25 --to 2026-08-24 + +# Principales requêtes de recherche sous forme de graphique à barres +mint analytics search --format graph + +# Retours au niveau de la page agrégés en JSON pour rediriger vers d'autres outils +mint analytics feedback --type page --format json + +# Afficher un seul fil de conversation +mint analytics conversation view conv_123 +``` + +--- +
## `mint config`
diff --git a/zh/cli/commands.mdx b/zh/cli/commands.mdx index 5fc9df029..5daa37d42 100644 --- a/zh/cli/commands.mdx +++ b/zh/cli/commands.mdx @@ -364,6 +364,152 @@ mint automations delete [flags] --- +
+ ## `mint analytics` +
+ +从终端查询文档分析数据。需要使用 `mint login` 进行身份验证。 + +```bash +mint analytics [flags] +``` + +所有子命令都接受以下共享选项: + +| 选项 | 描述 | +| --- | --- | +| `--subdomain` | 文档子域名。默认为通过 `mint config set subdomain` 设置的值,或你账户中的第一个项目。 | +| `--from` | 起始日期,格式为 `YYYY-MM-DD`。默认为七天前,或通过 `mint config set dateFrom` 设置的值。 | +| `--to` | 结束日期,格式为 `YYYY-MM-DD`。默认为今天,或通过 `mint config set dateTo` 设置的值。 | +| `--format` | 输出格式:`table`(美化)、`plain`(制表符分隔,可用于管道)、`json`(原始)或 `graph`(条形图)。默认为 `plain`,当 CLI 检测到 AI 或 CI 环境时默认为 `json`。 | + +
+ ### `mint analytics stats` +
+ +显示某个日期范围内的核心 KPI:浏览量、访客数、搜索次数、反馈和 assistant 使用情况。人类流量和 agent 流量分别报告。 + +```bash +mint analytics stats [flags] +``` + +| 选项 | 描述 | +| --- | --- | +| `--page` | 按指定页面路径过滤。 | + + + +显示搜索查询,包括命中次数、点击率、点击最多的页面和最后搜索日期。 + +```bash +mint analytics search [flags] +``` + +| 选项 | 描述 | +| --- | --- | +| `--query` | 按搜索查询子字符串过滤结果。 | +| `--page` | 过滤出以给定页面作为点击最多结果的查询。 | + +
+ ### `mint analytics feedback` +
+ +显示用户提交的反馈。默认返回单条反馈条目。传入 `--type page` 可查看按页面路径聚合的反馈,或传入 `--type code` 仅包含针对代码片段的反馈。 + +```bash +mint analytics feedback [flags] +``` + +| 选项 | 描述 | +| --- | --- | +| `--type` | `code` 表示代码片段反馈,`page` 表示按页面级聚合。省略则返回所有反馈条目。 | +| `--page` | 按指定页面路径过滤。 | + +
+ ### `mint analytics conversation` +
+ +查看 assistant 对话分析数据。 + +
+ #### `mint analytics conversation list` +
+ +列出最近的 assistant 对话,包括时间戳、用户的第一个问题和分类。 + +```bash +mint analytics conversation list [flags] +``` + +| 选项 | 描述 | +| --- | --- | +| `--page` | 过滤出其来源引用了给定页面路径的对话。 | + +
+ #### `mint analytics conversation view` +
+ +查看单个对话的完整消息线程。 + +```bash +mint analytics conversation view [flags] +``` + +| 参数 | 描述 | +| --- | --- | +| `id` | 来自 `mint analytics conversation list` 的对话 ID。 | + +
+ #### `mint analytics conversation buckets list` +
+ +列出按主题分组的对话集群,包括每个集群的对话数量和最近的提问日期。 + +```bash +mint analytics conversation buckets list [flags] +``` + +
+ #### `mint analytics conversation buckets view` +
+ +列出对话集群中的各个线程。 + +```bash +mint analytics conversation buckets view [flags] +``` + +| 参数 | 描述 | +| --- | --- | +| `id` | 来自 `mint analytics conversation buckets list` 的集群 ID。 | + +| 选项 | 描述 | +| --- | --- | +| `--limit` | 要返回的最大线程数。取值范围为 1 到 100。 | +| `--cursor` | 来自上一次响应的分页游标。 | + +
+ #### 示例 +
+ +```bash +# 最近 30 天的 KPI +mint analytics stats --from 2026-07-25 --to 2026-08-24 + +# 以条形图显示热门搜索查询 +mint analytics search --format graph + +# 以 JSON 格式聚合页面级反馈,便于管道传递给其他工具 +mint analytics feedback --type page --format json + +# 查看单个对话线程 +mint analytics conversation view conv_123 +``` + +--- +
## `mint config`