跳转到主要内容
将文档参与度数据自动发送到第三方分析平台。

​
所有集成项

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google Tag Manager（谷歌标签管理器）

Hightouch

Hotjar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​
启用分析

在 docs.json 中设置你的分析密钥。你可以免费添加任意数量的分析集成。 docs.json 的语法如下。只需包含你要接入的平台条目即可。
文档配置文件中的分析配置选项
"integrations": {
    "amplitude": {
        "apiKey": "必需"
    },
    "clearbit": {
        "publicApiKey": "必需"
    },
    "cookies": {
      "key": "必需",
      "value": "必需"
    },
    "fathom": {
        "siteId": "必需"
    },
    "ga4": {
        "measurementId": "必需"
    },
    "gtm": {
        "tagId": "必需"
    },
    "hightouch": {
        "apiKey": "必需",
        "apiHost": "可选"
    },
    "hotjar": {
        "hjid": "必需",
        "hjsv": "必需"
    },
    "koala": {
        "publicApiKey": "必需"
    },
    "logrocket": {
        "appId": "必需"
    },
    "mixpanel": {
        "projectToken": "必需"
    },
    "pirsch": {
        "id": "必需"
    },
    "plausible": {
        "domain": "必需"
    },
    "posthog": {
        "apiKey": "必需",
        "apiHost": "可选"
    },
    "segment": {
      "key": "必需"
    },
    "telemetry": {
      "enabled": "布尔"
    }
}

​
分析事件

我们会将以下事件发送到你的分析服务提供商。所有事件均使用 docs. 前缀。
事件名称描述
docs.accordion.close当用户关闭折叠面板时。
docs.accordion.open当用户打开折叠面板时。
docs.api_playground.request当用户在 API交互测试台 中调用 API 时。
docs.code_block.copy当用户从代码块复制代码时。
docs.code_block.ask_ai当用户请求文档助手解释代码块时。
docs.content.view当用户查看页面时。仅适用于默认不跟踪页面浏览的分析提供商。
docs.feedback.thumbs_up当用户点击正向反馈按钮时。
docs.feedback.thumbs_down当用户点击负向反馈按钮时。
docs.navitem.cta_click当用户点击行动号召按钮时。
docs.expandable.close当用户关闭可展开内容时。
docs.expandable.open当用户打开可展开内容时。
docs.navitem.click当用户点击页眉导航项时。
docs.footer.powered_by_mintlify_click当用户点击“Powered by Mintlify”链接时。
docs.assistant.source_click当用户在聊天中点击引文时。
docs.assistant.suggestion_click当用户在聊天中点击建议时。
docs.assistant.thumbs_up当用户在聊天中点击正向反馈按钮时。
docs.assistant.thumbs_down当用户在聊天中点击负向反馈按钮时。
docs.assistant.completed当聊天会话完成时。
docs.assistant.enter当用户发起聊天时。
docs.assistant.shared当用户分享聊天对话时。
docs.search.close当用户关闭搜索栏时。
docs.search.result_click当用户点击搜索结果时。
docs.context_menu.copy_page当用户将当前页面复制为 Markdown 时。
docs.context_menu.copy_mcp_link当用户复制托管的 模型上下文协议（MCP）服务器链接时。
docs.context_menu.ai_provider_click当用户点击某个 AI 提供商并以当前页面为上下文创建会话时。
docs.context_menu.install_mcp_server当用户在代码编辑器中安装托管的 模型上下文协议（MCP）服务器时。