集成
通过 docs.json 中的集成配置,将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。
使用 docs.json 中的 integrations 字段将第三方分析平台、聊天工具和其他服务连接到你的文档站点。
设置
在 docs.json 文件中将所有集成配置为 integrations 对象的属性:
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"
}
}分析
integrations.adobeobjectAdobe Analytics 集成。
Show Hide integrations.adobe
launchUrlstring (uri)required你的 Adobe Analytics launch URL。
integrations.amplitudeobjectAmplitude 分析集成。
Show Hide integrations.amplitude
apiKeystringrequired你的 Amplitude API key。
integrations.clarityobjectMicrosoft Clarity 会话录制和热力图集成。
Show Hide integrations.clarity
projectIdstringrequired你的 Microsoft Clarity 项目 ID。
integrations.fathomobjectFathom 分析集成。
Show Hide integrations.fathom
siteIdstringrequired你的 Fathom 站点 ID。
integrations.ga4objectGoogle Analytics 4 集成。
Show Hide integrations.ga4
measurementIdstring 匹配 ^Grequired你的 Google Analytics 4 测量 ID。必须以 G 开头。
integrations.gtmobjectGoogle Tag Manager 集成。
Show Hide integrations.gtm
tagIdstring 匹配 ^Grequired你的 Google Tag Manager 容器 ID。必须以 G 开头。
integrations.heapobjectHeap 分析集成。
Show Hide integrations.heap
appIdstringrequired你的 Heap 应用 ID。
integrations.hightouchobjectHightouch 数据激活集成。
Show Hide integrations.hightouch
writeKeystringrequired你的 Hightouch write key。
apiHoststring你的 Hightouch API 主机。
integrations.hotjarobjectHotjar 热力图和会话录制集成。
Show Hide integrations.hotjar
hjidstringrequired你的 Hotjar 站点 ID。
hjsvstringrequired你的 Hotjar 脚本版本。
integrations.logrocketobjectLogRocket 会话回放集成。
Show Hide integrations.logrocket
appIdstringrequired你的 LogRocket 应用 ID。
integrations.mixpanelobjectMixpanel 产品分析集成。
Show Hide integrations.mixpanel
projectTokenstringrequired你的 Mixpanel 项目 token。
integrations.pirschobjectPirsch 隐私友好型分析集成。
Show Hide integrations.pirsch
idstringrequired你的 Pirsch 站点 ID。
integrations.plausibleobjectPlausible 隐私友好型分析集成。
Show Hide integrations.plausible
domainstringrequired你的 Plausible 域名。
serverstring如果自托管,你的 Plausible 服务器。
integrations.posthogobjectPostHog 产品分析集成。
Show Hide integrations.posthog
apiKeystring 匹配 ^phc_required你的 PostHog API key。必须以 phc_ 开头。
apiHoststring (uri)你的 PostHog API 主机。自托管 PostHog 时必需。
sessionRecordingboolean是否启用会话录制。默认为 false。
integrations.segmentobjectSegment 客户数据平台集成。
Show Hide integrations.segment
keystringrequired你的 Segment write key。
聊天和支持
integrations.frontchatobjectFront 聊天小部件集成。
Show Hide integrations.frontchat
snippetIdstringrequired你的 Front 聊天代码片段 ID。最小长度:6。
integrations.intercomobjectIntercom 客户消息集成。
Show Hide integrations.intercom
appIdstringrequired你的 Intercom 应用 ID。最小长度:6。
数据增强
integrations.clearbitobjectClearbit 访客数据增强集成。
Show Hide integrations.clearbit
publicApiKeystringrequired你的 Clearbit 公开 API key。
平台设置
integrations.telemetryobjectMintlify 遥测设置。
Show Hide integrations.telemetry
enabledboolean是否启用 Mintlify 遥测。当设置为 false 时,反馈功能也会被禁用,不会显示在文档页面上。
integrations.cookiesobject文档站点的 cookie 设置。
Show Hide integrations.cookies
keystringCookie 键名。
valuestringCookie 值。
示例
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"
},
"posthog": {
"apiKey": "phc_XXXXXXXXXX"
},
"intercom": {
"appId": "abc12345"
},
"telemetry": {
"enabled": true
}
}