跳转到主要内容
通过连接第三方 Analytics 平台来跟踪用户如何与你的文档交互。Mintlify 会将互动事件发送到你已配置的 Analytics 提供商。

​
Analytics 集成的工作原理

当你将 Analytics 集成添加到文档站点时，Mintlify 会跟踪页面浏览、搜索查询、API 操作台请求和反馈提交等用户交互，并将这些数据发送到你的分析服务提供方。你可以通过在 docs.json 文件中添加 API key 来连接任意数量的已支持 Analytics 提供方。一旦你在配置中添加了这些服务，Analytics 事件就会开始流向相应的提供方，无需任何额外配置。

​
支持的平台

Amplitude

Mixpanel

清晰度

PostHog

Google Analytics 4

Google 标签管理器

Hightouch

Hotjar

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​
设置

将你的 analytics 提供商凭据添加到 docs.json 的 integrations 对象中。只需包含你想要使用的平台即可。
docs.json
"integrations": {
    "amplitude": {
        "apiKey": "required"
    },
    "clarity": {
        "projectId": "required"
    },
    "clearbit": {
        "publicApiKey": "required"
    },
    "cookies": {
      "key": "required",
      "value": "required"
    },
    "fathom": {
        "siteId": "required"
    },
    "ga4": {
        "measurementId": "required"
    },
    "gtm": {
        "tagId": "required"
    },
    "hightouch": {
        "apiKey": "required",
        "apiHost": "可选"
    },
    "hotjar": {
        "hjid": "required",
        "hjsv": "required"
    },
    "logrocket": {
        "appId": "required"
    },
    "mixpanel": {
        "projectToken": "required"
    },
    "pirsch": {
        "id": "required"
    },
    "plausible": {
        "domain": "required"
    },
    "posthog": {
        "apiKey": "required",
        "apiHost": "可选"
    },
    "segment": {
      "key": "required"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

​
示例配置

docs.json
{
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "posthog": {
      "apiKey": "phc_xxxxxxxxxxxxx",
      "apiHost": "https://app.posthog.com"
    },
    "mixpanel": {
      "projectToken": "xxxxxxxxxxxxx"
    }
  }
}

​
跟踪事件

所有事件都使用 docs. 前缀。

​
导航与页面浏览

Event nameDescription
docs.content.view当用户查看页面时。仅适用于默认不跟踪页面浏览次数的 Analytics 提供商。
docs.navitem.click当用户点击页眉导航项时。
docs.navitem.cta_click当用户点击某个行动呼吁（CTA）时。
docs.footer.powered_by_mintlify_click当用户点击“Powered by Mintlify”链接时。
Event nameDescription
docs.search.close当用户关闭搜索栏时。
docs.search.result_click当用户点击某个搜索结果时。

​
代码和 API 操作台

Event nameDescription
docs.code_block.copy当用户从代码块中复制代码时。
docs.code_block.ask_ai当用户请求 AI 助手解释代码块时。
docs.api_playground.request当用户在 API 操作台中调用 API 时。

​
交互组件

Event nameDescription
docs.accordion.open用户打开折叠面板。
docs.accordion.close用户关闭折叠面板。
docs.expandable.open用户打开可展开区域。
docs.expandable.close用户关闭可展开区域。

​
AI 助手和 Agent

Event nameDescription
docs.assistant.enter当用户打开 AI 助手时。
docs.assistant.completed当一次对话结束时。
docs.assistant.source_click当用户在对话中点击引用时。
docs.assistant.suggestion_click当用户在对话中点击建议时。
docs.assistant.ask_ai_on_text_selection当用户选择文本并点击“Ask AI”来询问该选区时。
docs.assistant.shared当用户分享一次对话时。
docs.assistant.thumbs_up当用户在助手回复上点击正向反馈按钮时。
docs.assistant.thumbs_down当用户在助手回复上点击负向反馈按钮时。
docs.assistant.spam_detected当助手在用户消息中检测到垃圾信息时。
docs.autopilot.suggestion.created当 Agent 创建文档建议时。
docs.autopilot.suggestion.no_suggestion当 Agent 判定不需要更新文档时。

​
上下文菜单

Event nameDescription
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 服务器时。