Skip to content
Mintlify
Mintlify
全局设置

集成

通过 docs.json 中的集成配置,将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。

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

设置

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

docs.json
"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  }
}

分析

integrations.adobeobject

Adobe Analytics 集成。

Show integrations.adobe
launchUrlstring (uri)required

你的 Adobe Analytics launch URL。

integrations.amplitudeobject

Amplitude 分析集成。

Show integrations.amplitude
apiKeystringrequired

你的 Amplitude API key。

integrations.clarityobject

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

Show integrations.clarity
projectIdstringrequired

你的 Microsoft Clarity 项目 ID。

integrations.fathomobject

Fathom 分析集成。

Show integrations.fathom
siteIdstringrequired

你的 Fathom 站点 ID。

integrations.ga4object

Google Analytics 4 集成。

Show integrations.ga4
measurementIdstring 匹配 ^Grequired

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

integrations.gtmobject

Google Tag Manager 集成。

Show integrations.gtm
tagIdstring 匹配 ^Grequired

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

integrations.heapobject

Heap 分析集成。

Show integrations.heap
appIdstringrequired

你的 Heap 应用 ID。

integrations.hightouchobject

Hightouch 数据激活集成。

Show integrations.hightouch
writeKeystringrequired

你的 Hightouch write key。

apiHoststring

你的 Hightouch API 主机。

integrations.hotjarobject

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

Show integrations.hotjar
hjidstringrequired

你的 Hotjar 站点 ID。

hjsvstringrequired

你的 Hotjar 脚本版本。

integrations.logrocketobject

LogRocket 会话回放集成。

Show integrations.logrocket
appIdstringrequired

你的 LogRocket 应用 ID。

integrations.mixpanelobject

Mixpanel 产品分析集成。

Show integrations.mixpanel
projectTokenstringrequired

你的 Mixpanel 项目 token。

integrations.pirschobject

Pirsch 隐私友好型分析集成。

Show integrations.pirsch
idstringrequired

你的 Pirsch 站点 ID。

integrations.plausibleobject

Plausible 隐私友好型分析集成。

Show integrations.plausible
domainstringrequired

你的 Plausible 域名。

serverstring

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

integrations.posthogobject

PostHog 产品分析集成。

Show integrations.posthog
apiKeystring 匹配 ^phc_required

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

apiHoststring (uri)

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

sessionRecordingboolean

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

integrations.segmentobject

Segment 客户数据平台集成。

Show integrations.segment
keystringrequired

你的 Segment write key。

聊天和支持

integrations.frontchatobject

Front 聊天小部件集成。

Show integrations.frontchat
snippetIdstringrequired

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

integrations.intercomobject

Intercom 客户消息集成。

Show integrations.intercom
appIdstringrequired

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

数据增强

integrations.clearbitobject

Clearbit 访客数据增强集成。

Show integrations.clearbit
publicApiKeystringrequired

你的 Clearbit 公开 API key。

平台设置

integrations.telemetryobject

Mintlify 遥测设置。

Show integrations.telemetry
enabledboolean

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

integrations.cookiesobject

文档站点的 cookie 设置。

Show integrations.cookies
keystring

Cookie 键名。

valuestring

Cookie 值。

示例

docs.json
"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  },
  "posthog": {
    "apiKey": "phc_XXXXXXXXXX"
  },
  "intercom": {
    "appId": "abc12345"
  },
  "telemetry": {
    "enabled": true
  }
}
Was this page helpful?Suggest editsRaise issue