Skip to content

Update from code changes: document widget analytics pathname opt-out - #6990

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/c943ddc9
Aug 17, 2026
Merged

Update from code changes: document widget analytics pathname opt-out#6990
ethanpalm merged 3 commits into
mainfrom
mintlify/c943ddc9

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

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: false init 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 new analytics field row in the AssistantConfig reference, and a new AssistantAnalyticsConfig reference 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, analytics row in AssistantConfig, and AssistantAnalyticsConfig reference 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.capturePathname init 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 init example setting analytics.capturePathname: false when path segments may contain sensitive data. Notes that changing this setting at runtime requires destroy() then a new init().

The configuration reference gains an analytics row on AssistantConfig and a new AssistantAnalyticsConfig table for capturePathname. The same additions are mirrored in the Spanish, French, and Chinese widget.mdx pages.

Reviewed by Cursor Bugbot for commit be00485. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 16, 2026, 11:34 AM

@mintlify

mintlify Bot commented Aug 16, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 16, 2026, 11:34 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@dks333

dks333 commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

@mintlify don't start a new section "Configure analytics privacy", it blows up the page

@mintlify

mintlify Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor Author

Removed the standalone analytics privacy section from all four widget pages while keeping the configuration reference entries intact.

@ethanpalm
ethanpalm merged commit 5c09a3c into main Aug 17, 2026
5 checks passed
@ethanpalm
ethanpalm deleted the mintlify/c943ddc9 branch August 17, 2026 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants