集成 - Mintlify

使用 docs.json 中的 integrations 字段将第三方分析平台、聊天工具和其他服务连接到你的文档站点。

设置

在 docs.json 文件中将所有集成配置为 integrations 对象的属性：

docs.json

"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  }
}

分析

object

Adobe Analytics 集成。

显示 integrations.adobe

string (uri)

必填

你的 Adobe Analytics launch URL。

object

Amplitude 分析集成。

显示 integrations.amplitude

string

必填

你的 Amplitude API key。

object

Microsoft Clarity 会话录制和热力图集成。

显示 integrations.clarity

string

必填

你的 Microsoft Clarity 项目 ID。

object

Fathom 分析集成。

显示 integrations.fathom

string

必填

你的 Fathom 站点 ID。

object

Google Analytics 4 集成。

显示 integrations.ga4

string 匹配 ^G

必填

你的 Google Analytics 4 测量 ID。必须以 G 开头。

object

Google Tag Manager 集成。

显示 integrations.gtm

string 匹配 ^G

必填

你的 Google Tag Manager 容器 ID。必须以 G 开头。

object

Heap 分析集成。

显示 integrations.heap

string

必填

你的 Heap 应用 ID。

object

Hightouch 数据激活集成。

显示 integrations.hightouch

string

必填

你的 Hightouch write key。

string

你的 Hightouch API 主机。

object

Hotjar 热力图和会话录制集成。

显示 integrations.hotjar

string

必填

你的 Hotjar 站点 ID。

string

必填

你的 Hotjar 脚本版本。

object

LogRocket 会话回放集成。

显示 integrations.logrocket

string

必填

你的 LogRocket 应用 ID。

object

Mixpanel 产品分析集成。

显示 integrations.mixpanel

string

必填

你的 Mixpanel 项目 token。

object

Pirsch 隐私友好型分析集成。

显示 integrations.pirsch

string

必填

你的 Pirsch 站点 ID。

object

Plausible 隐私友好型分析集成。

显示 integrations.plausible

string

必填

你的 Plausible 域名。

string

如果自托管，你的 Plausible 服务器。

object

PostHog 产品分析集成。

显示 integrations.posthog

string 匹配 ^phc_

必填

你的 PostHog API key。必须以 phc_ 开头。

string (uri)

你的 PostHog API 主机。自托管 PostHog 时必需。

boolean

是否启用会话录制。默认为 false。

object

Segment 客户数据平台集成。

显示 integrations.segment

string

必填

你的 Segment write key。

聊天和支持

object

Front 聊天小部件集成。

显示 integrations.frontchat

string

必填

你的 Front 聊天代码片段 ID。最小长度：6。

object

Intercom 客户消息集成。

显示 integrations.intercom

string

必填

你的 Intercom 应用 ID。最小长度：6。

数据增强

object

Clearbit 访客数据增强集成。

显示 integrations.clearbit

string

必填

你的 Clearbit 公开 API key。

平台设置

object

Mintlify 遥测设置。

显示 integrations.telemetry

boolean

是否启用 Mintlify 遥测。当设置为 false 时，反馈功能也会被禁用，不会显示在文档页面上。

object

文档站点的 cookie 设置。

显示 integrations.cookies

string

Cookie 键名。

string

Cookie 值。

示例

docs.json

"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  },
  "posthog": {
    "apiKey": "phc_XXXXXXXXXX"
  },
  "intercom": {
    "appId": "abc12345"
  },
  "telemetry": {
    "enabled": true
  }
}

快速入门

组织

自定义

创建内容

编写 API 文档

部署

优化

集成

设置

分析

聊天和支持

数据增强

平台设置

示例

​设置

​分析

​聊天和支持

​数据增强

​平台设置

​示例

设置

分析

聊天和支持

数据增强

平台设置

示例