Analytics integrations

与分析平台集成以跟踪事件

自动将文档参与度数据发送到你的第三方 Analytics 提供商。

​

所有 integrations

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google 标签管理器

Hightouch

Hotjar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​

启用 Analytics

在 docs.json 中设置你的 analytics key。你可以免费添加任意数量的 analytics integrations。

docs.json 的语法如下。你只需包含需要连接的平台条目即可。

Analytics options in 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": "布尔值"
    }
}

​

Analytics 事件

我们会将以下事件发送到你的 Analytics 提供商。所有事件均使用 docs. 前缀。

Event name	Description
docs.accordion.close	当用户关闭折叠面板时。
docs.accordion.open	当用户打开折叠面板时。
docs.api_playground.request	当用户在 API 操作台中调用 API 时。
docs.code_block.copy	当用户从代码块复制代码时。
docs.code_block.ask_ai	当用户请求 AI 助手解释代码块时。
docs.content.view	当用户查看页面时。仅适用于默认不跟踪页面浏览的 Analytics 提供商。
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 提供商并以当前页面为 context 创建对话时。
docs.context_menu.install_mcp_server	当用户在代码编辑器中安装托管的 MCP 服务器时。