Update from code changes: document widget analytics pathname opt-out - #6990
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
@mintlify don't start a new section "Configure analytics privacy", it blows up the page |
Contributor
Author
|
Removed the standalone analytics privacy section from all four widget pages while keeping the configuration reference entries intact. |
ethanpalm
approved these changes
Aug 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The assistant widget now captures the embedding page's current pathname on internal analytics events by default, and installers can opt out with a new
analytics.capturePathname: falseinit option. Query strings, fragments, full URLs, and referrers are still never collected, and pathnames are capped at 500 characters. This PR adds a "Configure analytics privacy" section to the widget guide, a newanalyticsfield row in theAssistantConfigreference, and a newAssistantAnalyticsConfigreference block. Mirrored the same additions in the Spanish, French, and Chinese widget pages.Upstream PR: https://github.com/mintlify/mint/pull/10185
Changes
assistant/widget.mdx: new "Configure analytics privacy" section,analyticsrow inAssistantConfig, andAssistantAnalyticsConfigreference table.es/assistant/widget.mdx,fr/assistant/widget.mdx,zh/assistant/widget.mdx: same additions, translated.Note
Low Risk
Documentation-only changes with no runtime or API implementation in this repo.
Overview
Documents the new
analytics.capturePathnameinit option and related privacy behavior for the Mintlify Assistant widget.Adds a Configure analytics privacy section explaining that internal widget analytics include the embedding page pathname by default (500-char cap, no query/fragment/full URL/referrer), with an
initexample settinganalytics.capturePathname: falsewhen path segments may contain sensitive data. Notes that changing this setting at runtime requiresdestroy()then a newinit().The configuration reference gains an
analyticsrow onAssistantConfigand a newAssistantAnalyticsConfigtable forcapturePathname. The same additions are mirrored in the Spanish, French, and Chinesewidget.mdxpages.Reviewed by Cursor Bugbot for commit be00485. Bugbot is set up for automated code reviews on this repo. Configure here.