Skip to content

Update from code changes: document mint analytics CLI command #7067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 2 commits into from
Aug 24, 2026
+564 −0
Merged

Update from code changes: document mint analytics CLI command #7067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a8b2ab
docs: document restored mint analytics CLI command
mintlify[bot] Aug 24, 2026
446cd67
docs: wrap translated mint analytics headings in id divs
mintlify[bot] Aug 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 126 additions & 0 deletions cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,9 +91,9 @@

| Client | Global configuration | Project configuration |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |

Check warning on line 94 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L94 

Use 'Claude' instead of 'claude'.
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | User `mcp.json` | `.vscode/mcp.json` |

Check warning on line 96 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L96 

Use 'VSCode' instead of 'vscode'.
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
Expand Down Expand Up @@ -202,7 +202,7 @@

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it.

Check warning on line 205 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L205 

In general, use active voice instead of passive voice ('is bound').

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/deployment/custom-domain) page in your dashboard for the remaining values.
Expand Down Expand Up @@ -326,6 +326,132 @@

---

## `mint analytics`

Query documentation analytics from the terminal. Requires authentication with `mint login`.

```bash
mint analytics <subcommand> [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.

Check warning on line 348 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L348 

Did you really mean 'KPIs'?

Check warning on line 348 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L348 

In general, use active voice instead of passive voice ('are reported').

```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 <id> [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 <id> [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`.
Expand Down Expand Up @@ -366,7 +492,7 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 495 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L495 

In general, use active voice instead of passive voice ('are fetched').

```bash
# Check a specific page
Expand Down Expand Up @@ -505,13 +631,13 @@
mint format
```

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

Check warning on line 634 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L634 

In general, use active voice instead of passive voice ('are left').

<Warning>
`mint format` rewrites files in place. Commit or stash your changes before running it so you can review the diff.
</Warning>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting.

Check warning on line 640 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L640 

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down Expand Up @@ -566,7 +692,7 @@

## Telemetry

The CLI collects anonymous usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. Mintlify does **not** collect personally identifiable information, project content, or file paths.

Check warning on line 695 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L695 

Did you really mean 'informat'?

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
146 changes: 146 additions & 0 deletions es/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,152 @@ mint automations delete <id> [flags]

---

<div id="mint-analytics">
## `mint analytics`
</div>

Consulta las analíticas de la documentación desde la terminal. Requiere autenticación con `mint login`.

```bash
mint analytics <subcommand> [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. |

<div id="mint-analytics-stats">
### `mint analytics stats`
</div>

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. |

<div id="mint-analytics-search">
### `mint analytics search`
</div>

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. |

<div id="mint-analytics-feedback">
### `mint analytics feedback`
</div>

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. |

<div id="mint-analytics-conversation">
### `mint analytics conversation`
</div>

Consulta las analíticas de las conversaciones del asistente.

<div id="mint-analytics-conversation-list">
#### `mint analytics conversation list`
</div>

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. |

<div id="mint-analytics-conversation-view">
#### `mint analytics conversation view`
</div>

Consulta el hilo completo de mensajes de una sola conversación.

```bash
mint analytics conversation view <id> [flags]
```

| Argumento | Descripción |
| --- | --- |
| `id` | ID de la conversación obtenido de `mint analytics conversation list`. |

<div id="mint-analytics-conversation-buckets-list">
#### `mint analytics conversation buckets list`
</div>

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]
```

<div id="mint-analytics-conversation-buckets-view">
#### `mint analytics conversation buckets view`
</div>

Lista los hilos individuales de un bucket de conversaciones.

```bash
mint analytics conversation buckets view <id> [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. |

<div id="analytics-examples">
#### Ejemplos
</div>

```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
```

---

<div id="mint-config">
## `mint config`
</div>
Expand Down
Loading