From e3792784d7b86c4ebf77cd29f06b58dfdf573164 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sun, 16 Aug 2026 11:32:28 +0000 Subject: [PATCH 1/3] docs: document widget analytics pathname capture and opt-out --- assistant/widget.mdx | 24 ++++++++++++++++++++++++ es/assistant/widget.mdx | 26 ++++++++++++++++++++++++++ fr/assistant/widget.mdx | 26 ++++++++++++++++++++++++++ zh/assistant/widget.mdx | 26 ++++++++++++++++++++++++++ 4 files changed, 102 insertions(+) diff --git a/assistant/widget.mdx b/assistant/widget.mdx index 71bf178f5..62dffc1cd 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -161,6 +161,23 @@ await window.MintlifyAssistant.update({ Pass `null` on a field to clear that filter, or `filter: null` to clear both. +## Configure analytics privacy + +Mintlify captures internal usage analytics for the widget. By default, each event includes the embedding page's current pathname so you can see which pages drive assistant usage. The pathname is capped at 500 characters and sent without its query string or fragment. Query parameters, fragments, full URLs, and referrers are never collected. + +If your site places tokens, personal data, or other private values in path segments, disable pathname capture at initialization: + +```js +await window.MintlifyAssistant.init({ + id: "YOUR_WIDGET_ID", + analytics: { + capturePathname: false, + }, +}); +``` + +Changing `analytics.capturePathname` at runtime requires `destroy()` followed by a new `init()`. + ## Configuration reference ### `AssistantConfig` @@ -180,6 +197,7 @@ Pass this object to `init()`. | `starterQuestions` | string[] | Sets up to three empty-state prompts for this embed. | | `filter` | [`AssistantFilter`](#assistantfilter) | Restricts retrieval to a docs language and version. | | `hooks` | [`AssistantHooks`](#assistanthooks) | Event and error observers. | +| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Internal widget analytics settings. | ### `AssistantAppearance` @@ -205,6 +223,12 @@ The widget does not support arbitrary CSS or neutral-palette overrides. The clos | `language` | string or `null` | Restricts retrieval to a [supported language code](/organize/settings-reference#navigation-global-languages), such as `en`. Omit to search all languages. | | `version` | string or `null` | Restricts retrieval to a docs version, such as `v2`. Omit to search all versions. | +### `AssistantAnalyticsConfig` + +| Option | Type | Description | +| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `capturePathname` | boolean | Includes the embedding page's current pathname in internal widget analytics events. The default is `true`. Set to `false` to opt out. | + ### `AssistantLabels` | Option | Values | Description | diff --git a/es/assistant/widget.mdx b/es/assistant/widget.mdx index a54cd322c..4e1204008 100644 --- a/es/assistant/widget.mdx +++ b/es/assistant/widget.mdx @@ -175,6 +175,23 @@ await window.MintlifyAssistant.update({ Pasa `null` en un campo para borrar ese filtro, o `filter: null` para borrar ambos. +## Configurar la privacidad de la analítica + +Mintlify captura analíticas de uso internas del widget. De forma predeterminada, cada evento incluye la ruta actual de la página en la que se incrusta el widget para que puedas ver qué páginas generan uso del asistente. La ruta se limita a 500 caracteres y se envía sin su cadena de consulta ni su fragmento. Nunca se recopilan parámetros de consulta, fragmentos, URLs completas ni referrers. + +Si tu sitio incluye tokens, datos personales u otros valores privados en los segmentos de la ruta, desactiva la captura de la ruta en la inicialización: + +```js +await window.MintlifyAssistant.init({ + id: "YOUR_WIDGET_ID", + analytics: { + capturePathname: false, + }, +}); +``` + +Cambiar `analytics.capturePathname` en tiempo de ejecución requiere llamar a `destroy()` seguido de un nuevo `init()`. +
## Referencia de configuración
@@ -198,6 +215,7 @@ Pasa este objeto a `init()`. | `starterQuestions` | string[] | Establece hasta **tres** sugerencias de estado vacío para este embed. | | `filter` | [`AssistantFilter`](#assistantfilter) | Restringe la recuperación a un idioma y versión de la documentación. | | `hooks` | [`AssistantHooks`](#assistanthooks) | Observadores de eventos y errores. | +| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Configuración de la analítica interna del widget. |
### `AssistantAppearance` @@ -227,6 +245,14 @@ No se admiten sobrescrituras arbitrarias de CSS ni de paleta neutra. El Shadow D | `language` | string or `null` | Restringe la recuperación a un [código de idioma admitido](/es/organize/settings-reference#navigation-global-languages), como `en`. Omítelo para buscar en todos los idiomas. | | `version` | string or `null` | Restringe la recuperación a una versión de la documentación, como `v2`. Omítela para buscar en todas las versiones. | +
+ ### `AssistantAnalyticsConfig` +
+ +| Option | Type | Description | +| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `capturePathname` | boolean | Incluye la ruta actual de la página que incrusta el widget en los eventos internos de analítica. El valor por defecto es `true`. Establécelo en `false` para desactivarlo. | +
### `AssistantLabels`
diff --git a/fr/assistant/widget.mdx b/fr/assistant/widget.mdx index f84e72c04..c7e6908a6 100644 --- a/fr/assistant/widget.mdx +++ b/fr/assistant/widget.mdx @@ -175,6 +175,23 @@ await window.MintlifyAssistant.update({ Passez `null` sur un champ pour effacer ce filtre, ou `filter: null` pour effacer les deux. +## Configurer la confidentialité des analyses + +Mintlify capture des analyses d'utilisation internes du widget. Par défaut, chaque événement inclut le chemin (pathname) actuel de la page qui intègre le widget afin que vous puissiez voir quelles pages génèrent l'utilisation de l'assistant. Le chemin est limité à 500 caractères et envoyé sans sa chaîne de requête ni son fragment. Les paramètres de requête, les fragments, les URL complètes et les référents ne sont jamais collectés. + +Si votre site place des tokens, des données personnelles ou d'autres valeurs privées dans les segments du chemin, désactivez la capture du chemin à l'initialisation : + +```js +await window.MintlifyAssistant.init({ + id: "YOUR_WIDGET_ID", + analytics: { + capturePathname: false, + }, +}); +``` + +Modifier `analytics.capturePathname` à l'exécution nécessite d'appeler `destroy()` puis un nouvel `init()`. +
## Référence de configuration
@@ -198,6 +215,7 @@ Passez cet objet à `init()`. | `starterQuestions` | string[] | Définit jusqu'à **trois** invites d'état vide pour cette intégration. | | `filter` | [`AssistantFilter`](#assistantfilter) | Restreint la recherche à une langue et à une version de la documentation. | | `hooks` | [`AssistantHooks`](#assistanthooks) | Observateurs d'événements et d'erreurs. | +| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | Paramètres des analyses internes du widget. |
### `AssistantAppearance` @@ -227,6 +245,14 @@ Les substitutions CSS arbitraires et les palettes neutres ne sont pas prises en | `language` | string or `null` | Restreint la recherche à un [code de langue pris en charge](/fr/organize/settings-reference#navigation-global-languages), tel que `en`. Omettez pour rechercher dans toutes les langues. | | `version` | string or `null` | Restreint la recherche à une version de la documentation, telle que `v2`. Omettez pour rechercher dans toutes les versions. | +
+ ### `AssistantAnalyticsConfig` +
+ +| Option | Type | Description | +| ------------------ | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| `capturePathname` | boolean | Inclut le chemin actuel de la page qui intègre le widget dans les événements d'analyse internes. La valeur par défaut est `true`. Définissez-le sur `false` pour ne pas participer. | +
### `AssistantLabels`
diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index 08c8daa0f..cb99a2228 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -175,6 +175,23 @@ await window.MintlifyAssistant.update({ 对某个字段传入 `null` 可清除该筛选条件,传入 `filter: null` 可同时清除两个筛选条件。 +## 配置分析隐私 + +Mintlify 会为小组件收集内部使用分析。默认情况下,每个事件都会包含嵌入页面的当前路径,便于你查看哪些页面驱动了助手的使用。路径长度上限为 500 个字符,并且不包含查询字符串或片段。查询参数、片段、完整 URL 和来源(referrer)始终不会被收集。 + +如果你的站点在路径段中包含令牌、个人数据或其他私有值,请在初始化时禁用路径捕获: + +```js +await window.MintlifyAssistant.init({ + id: "YOUR_WIDGET_ID", + analytics: { + capturePathname: false, + }, +}); +``` + +在运行时更改 `analytics.capturePathname` 需要先调用 `destroy()`,再调用新的 `init()`。 +
## 配置参考
@@ -198,6 +215,7 @@ await window.MintlifyAssistant.update({ | `starterQuestions` | string[] | 为该嵌入设置最多 **三** 条空状态提示。 | | `filter` | [`AssistantFilter`](#assistantfilter) | 将检索限定到指定的文档语言和版本。 | | `hooks` | [`AssistantHooks`](#assistanthooks) | 事件和错误观察者。 | +| `analytics` | [`AssistantAnalyticsConfig`](#assistantanalyticsconfig) | 内部小组件分析设置。 |
### `AssistantAppearance` @@ -227,6 +245,14 @@ await window.MintlifyAssistant.update({ | `language` | string or `null` | 将检索限定到[受支持的语言代码](/zh/organize/settings-reference#navigation-global-languages),例如 `en`。省略以在所有语言中检索。 | | `version` | string or `null` | 将检索限定到指定的文档版本,例如 `v2`。省略以在所有版本中检索。 | +
+ ### `AssistantAnalyticsConfig` +
+ +| Option | Type | Description | +| ------------------ | ------- | ----------------------------------------------------------------------------------------------------------------------- | +| `capturePathname` | boolean | 在内部小组件分析事件中包含嵌入页面的当前路径。默认值为 `true`。设置为 `false` 可选择停用。 | +
### `AssistantLabels`
From be004850ac93180b202c08b69aa5cc8928c4a1bb Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sun, 16 Aug 2026 11:34:28 +0000 Subject: [PATCH 2/3] docs: wrap translated analytics-privacy heading in anchor div --- es/assistant/widget.mdx | 4 +++- fr/assistant/widget.mdx | 4 +++- zh/assistant/widget.mdx | 4 +++- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/es/assistant/widget.mdx b/es/assistant/widget.mdx index 4e1204008..dc53da890 100644 --- a/es/assistant/widget.mdx +++ b/es/assistant/widget.mdx @@ -175,7 +175,9 @@ await window.MintlifyAssistant.update({ Pasa `null` en un campo para borrar ese filtro, o `filter: null` para borrar ambos. -## Configurar la privacidad de la analítica +
+ ## Configurar la privacidad de la analítica +
Mintlify captura analíticas de uso internas del widget. De forma predeterminada, cada evento incluye la ruta actual de la página en la que se incrusta el widget para que puedas ver qué páginas generan uso del asistente. La ruta se limita a 500 caracteres y se envía sin su cadena de consulta ni su fragmento. Nunca se recopilan parámetros de consulta, fragmentos, URLs completas ni referrers. diff --git a/fr/assistant/widget.mdx b/fr/assistant/widget.mdx index c7e6908a6..074fa64b4 100644 --- a/fr/assistant/widget.mdx +++ b/fr/assistant/widget.mdx @@ -175,7 +175,9 @@ await window.MintlifyAssistant.update({ Passez `null` sur un champ pour effacer ce filtre, ou `filter: null` pour effacer les deux. -## Configurer la confidentialité des analyses +
+ ## Configurer la confidentialité des analyses +
Mintlify capture des analyses d'utilisation internes du widget. Par défaut, chaque événement inclut le chemin (pathname) actuel de la page qui intègre le widget afin que vous puissiez voir quelles pages génèrent l'utilisation de l'assistant. Le chemin est limité à 500 caractères et envoyé sans sa chaîne de requête ni son fragment. Les paramètres de requête, les fragments, les URL complètes et les référents ne sont jamais collectés. diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index cb99a2228..d5298147a 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -175,7 +175,9 @@ await window.MintlifyAssistant.update({ 对某个字段传入 `null` 可清除该筛选条件,传入 `filter: null` 可同时清除两个筛选条件。 -## 配置分析隐私 +
+ ## 配置分析隐私 +
Mintlify 会为小组件收集内部使用分析。默认情况下,每个事件都会包含嵌入页面的当前路径,便于你查看哪些页面驱动了助手的使用。路径长度上限为 500 个字符,并且不包含查询字符串或片段。查询参数、片段、完整 URL 和来源(referrer)始终不会被收集。 From e57859b67df6e22454cd138df3bfb200ebef522c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Aug 2026 16:07:40 +0000 Subject: [PATCH 3/3] docs: remove standalone analytics privacy section from widget pages --- assistant/widget.mdx | 17 ----------------- es/assistant/widget.mdx | 19 ------------------- fr/assistant/widget.mdx | 19 ------------------- zh/assistant/widget.mdx | 19 ------------------- 4 files changed, 74 deletions(-) diff --git a/assistant/widget.mdx b/assistant/widget.mdx index 62dffc1cd..c439aa7c9 100644 --- a/assistant/widget.mdx +++ b/assistant/widget.mdx @@ -161,23 +161,6 @@ await window.MintlifyAssistant.update({ Pass `null` on a field to clear that filter, or `filter: null` to clear both. -## Configure analytics privacy - -Mintlify captures internal usage analytics for the widget. By default, each event includes the embedding page's current pathname so you can see which pages drive assistant usage. The pathname is capped at 500 characters and sent without its query string or fragment. Query parameters, fragments, full URLs, and referrers are never collected. - -If your site places tokens, personal data, or other private values in path segments, disable pathname capture at initialization: - -```js -await window.MintlifyAssistant.init({ - id: "YOUR_WIDGET_ID", - analytics: { - capturePathname: false, - }, -}); -``` - -Changing `analytics.capturePathname` at runtime requires `destroy()` followed by a new `init()`. - ## Configuration reference ### `AssistantConfig` diff --git a/es/assistant/widget.mdx b/es/assistant/widget.mdx index dc53da890..1a4c60acb 100644 --- a/es/assistant/widget.mdx +++ b/es/assistant/widget.mdx @@ -175,25 +175,6 @@ await window.MintlifyAssistant.update({ Pasa `null` en un campo para borrar ese filtro, o `filter: null` para borrar ambos. -
- ## Configurar la privacidad de la analítica -
- -Mintlify captura analíticas de uso internas del widget. De forma predeterminada, cada evento incluye la ruta actual de la página en la que se incrusta el widget para que puedas ver qué páginas generan uso del asistente. La ruta se limita a 500 caracteres y se envía sin su cadena de consulta ni su fragmento. Nunca se recopilan parámetros de consulta, fragmentos, URLs completas ni referrers. - -Si tu sitio incluye tokens, datos personales u otros valores privados en los segmentos de la ruta, desactiva la captura de la ruta en la inicialización: - -```js -await window.MintlifyAssistant.init({ - id: "YOUR_WIDGET_ID", - analytics: { - capturePathname: false, - }, -}); -``` - -Cambiar `analytics.capturePathname` en tiempo de ejecución requiere llamar a `destroy()` seguido de un nuevo `init()`. -
## Referencia de configuración
diff --git a/fr/assistant/widget.mdx b/fr/assistant/widget.mdx index 074fa64b4..18f618628 100644 --- a/fr/assistant/widget.mdx +++ b/fr/assistant/widget.mdx @@ -175,25 +175,6 @@ await window.MintlifyAssistant.update({ Passez `null` sur un champ pour effacer ce filtre, ou `filter: null` pour effacer les deux. -
- ## Configurer la confidentialité des analyses -
- -Mintlify capture des analyses d'utilisation internes du widget. Par défaut, chaque événement inclut le chemin (pathname) actuel de la page qui intègre le widget afin que vous puissiez voir quelles pages génèrent l'utilisation de l'assistant. Le chemin est limité à 500 caractères et envoyé sans sa chaîne de requête ni son fragment. Les paramètres de requête, les fragments, les URL complètes et les référents ne sont jamais collectés. - -Si votre site place des tokens, des données personnelles ou d'autres valeurs privées dans les segments du chemin, désactivez la capture du chemin à l'initialisation : - -```js -await window.MintlifyAssistant.init({ - id: "YOUR_WIDGET_ID", - analytics: { - capturePathname: false, - }, -}); -``` - -Modifier `analytics.capturePathname` à l'exécution nécessite d'appeler `destroy()` puis un nouvel `init()`. -
## Référence de configuration
diff --git a/zh/assistant/widget.mdx b/zh/assistant/widget.mdx index d5298147a..b2ee18b0c 100644 --- a/zh/assistant/widget.mdx +++ b/zh/assistant/widget.mdx @@ -175,25 +175,6 @@ await window.MintlifyAssistant.update({ 对某个字段传入 `null` 可清除该筛选条件,传入 `filter: null` 可同时清除两个筛选条件。 -
- ## 配置分析隐私 -
- -Mintlify 会为小组件收集内部使用分析。默认情况下,每个事件都会包含嵌入页面的当前路径,便于你查看哪些页面驱动了助手的使用。路径长度上限为 500 个字符,并且不包含查询字符串或片段。查询参数、片段、完整 URL 和来源(referrer)始终不会被收集。 - -如果你的站点在路径段中包含令牌、个人数据或其他私有值,请在初始化时禁用路径捕获: - -```js -await window.MintlifyAssistant.init({ - id: "YOUR_WIDGET_ID", - analytics: { - capturePathname: false, - }, -}); -``` - -在运行时更改 `analytics.capturePathname` 需要先调用 `destroy()`,再调用新的 `init()`。 -
## 配置参考