分析与会话回放提供商
通过一个 docs.json 配置块添加 PostHog、Mixpanel、Amplitude、Hotjar、Clarity、Fathom、Pirsch、Heap、LogRocket、Segment、Clearbit、Hightouch 或 Koala。
Jamdesk 会从 docs.json 加载另外 13 个分析、会话回放和身份提供商的脚本。在 integrations 下添加该提供商的配置块即可。Jamdesk 会在您已发布文档站点的每个页面中注入其脚本。
Jamdesk 在加载脚本前会对每个值进行严格的格式检查。格式错误的值（多余字符、前缀错误、长度不对）会被静默跳过。您不会看到错误页面，也不会出现损坏的脚本标签。如果某个提供商未能加载，请从其仪表板重新复制该值，并对照下方的格式进行检查。
从仪表板配置
最快的设置方式是前往 Dashboard → Integrations。选择提供商的卡片并粘贴其密钥。Jamdesk 会提交 docs.json 配置块并触发重新构建（仅限已连接 GitHub 的项目）。如需直接编辑 docs.json 或用于仅使用 CLI 的项目，请参阅以下各节。
PostHog
产品分析、会话回放和功能开关。
格式： 项目 API 密钥以 phc_ 开头，后跟 8-64 个字母或数字。可选的 API 主机必须是 https:// URL。
在 PostHog 中前往 Settings → Project → Project API key 查找您的密钥。
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost 为可选项，默认为 https://us.i.posthog.com。如果您使用欧盟云主机或反向代理 URL，请将其设置为该地址。
Mixpanel
事件分析和转化漏斗。
格式： 项目令牌恰好为 32 个小写十六进制字符（0-9、a-f）。
在 Mixpanel 中前往 Project Settings → Access Keys → Project Token 查找您的令牌。
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
产品分析和行为群组。
格式： API 密钥恰好为 32 个小写十六进制字符（0-9、a-f）。
在 Amplitude 中前往 Settings → Projects → your project → API Key 查找您的密钥。
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
热力图和会话录制。
格式： 站点 ID 为 1-12 位数字。代码片段版本为 1-4 位数字（通常为 6）。
在 Hotjar 中前往 Sites & Organizations → your site 查找站点 ID 和代码片段版本。
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar 会录制访客会话。如果您的读者受 GDPR、CCPA 或类似法规约束，请将其置于 Cookie Consent 之后进行控制。
Microsoft Clarity
免费的热力图和会话录制。
格式： 项目 ID 为 4-32 个字母或数字。
在 Clarity 中前往 Settings → Overview → Project ID 查找您的项目 ID。
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity 会录制访客会话。如果您的读者受 GDPR、CCPA 或类似法规约束，请将其置于 Cookie Consent 之后进行控制。
Fathom
注重隐私、无 Cookie 的分析。
格式： 站点 ID 为 4-16 个字母或数字。
在 Fathom 中前往 Settings → Sites → your site 查找您的站点 ID。
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
无 Cookie、注重隐私的分析。
格式： 识别代码为 4-64 个字母或数字。
在 Pirsch 中前往 Settings → Developer → Identification Code 查找您的代码。
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
自动事件捕获，无需手动埋点。
格式： App ID 为 6-20 位数字。
在 Heap 中前往 Account → Manage → Projects 查找您的 App ID。
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
会话回放，包含控制台和网络日志。
格式： App ID 由两个用斜杠（org-slug/app-slug）分隔的 slug 段组成。每段为 2-64 个小写字母、数字或连字符。
在 LogRocket 中前往 Settings → Project Setup 查找您的 App ID。
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket 会录制访客会话，包括控制台和网络活动。如果您的读者受 GDPR、CCPA 或类似法规约束，请将其置于 Cookie Consent 之后进行控制。
Segment
将文档事件从单一来源路由到所有下游工具。
格式： 写入密钥为 10-64 个字母或数字（不含连字符或下划线）。
在 Segment 中前往 Connections → Sources → your JS source → Settings → API Keys 查找您的写入密钥。
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
识别并丰富匿名访客信息。
格式： 公共 API 密钥以 pk_ 开头，后跟 6-64 个字母或数字。
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
将文档事件直接发送到您的数据仓库。
格式： 写入密钥为 8-128 个字符（字母、数字、:、.、_、-）。可选的 API 主机为 4-64 个字符（字母、数字、.、-）。
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost 为可选项。仅当您使用自托管或特定区域的 Hightouch 事件端点时才需设置。
Koala
识别高意向访客，用于销售和营销。
格式： 公共 API 密钥以 pk_ 开头，后跟 6-64 个字母或数字。
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}同意控制
上述每个提供商都遵循 integrations.cookies 设置。设置后，只有在您的同意横幅记录用户同意后，它们的脚本才会加载。设置方法请参阅 Cookie Consent。若未设置，每个脚本都会在页面加载时为所有访客加载。