mintlify__docs/zh/organize/settings-integrations.mdx

---
title: "集成"
description: "通过 docs.json 中的集成配置，将分析平台、聊天小部件和第三方服务连接到你的 Mintlify 文档站点。"
keywords: ["集成", "分析", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"]
boost: 3
---

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

## 设置

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

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

### 分析

<ResponseField name="integrations.adobe" type="object">
  Adobe Analytics 集成。

  <Expandable title="integrations.adobe">
    <ResponseField name="launchUrl" type="string (uri)" required>
      你的 Adobe Analytics launch URL。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.amplitude" type="object">
  Amplitude 分析集成。

  <Expandable title="integrations.amplitude">
    <ResponseField name="apiKey" type="string" required>
      你的 Amplitude API key。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.clarity" type="object">
  Microsoft Clarity 会话录制和热力图集成。

  <Expandable title="integrations.clarity">
    <ResponseField name="projectId" type="string" required>
      你的 Microsoft Clarity 项目 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.fathom" type="object">
  Fathom 分析集成。

  <Expandable title="integrations.fathom">
    <ResponseField name="siteId" type="string" required>
      你的 Fathom 站点 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.ga4" type="object">
  Google Analytics 4 集成。

  <Expandable title="integrations.ga4">
    <ResponseField name="measurementId" type="string 匹配 ^G" required>
      你的 Google Analytics 4 测量 ID。必须以 `G` 开头。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.gtm" type="object">
  Google Tag Manager 集成。

  <Expandable title="integrations.gtm">
    <ResponseField name="tagId" type="string 匹配 ^G" required>
      你的 Google Tag Manager 容器 ID。必须以 `G` 开头。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.heap" type="object">
  Heap 分析集成。

  <Expandable title="integrations.heap">
    <ResponseField name="appId" type="string" required>
      你的 Heap 应用 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.hightouch" type="object">
  Hightouch 数据激活集成。

  <Expandable title="integrations.hightouch">
    <ResponseField name="writeKey" type="string" required>
      你的 Hightouch write key。
    </ResponseField>
    <ResponseField name="apiHost" type="string">
      你的 Hightouch API 主机。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.hotjar" type="object">
  Hotjar 热力图和会话录制集成。

  <Expandable title="integrations.hotjar">
    <ResponseField name="hjid" type="string" required>
      你的 Hotjar 站点 ID。
    </ResponseField>
    <ResponseField name="hjsv" type="string" required>
      你的 Hotjar 脚本版本。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.logrocket" type="object">
  LogRocket 会话回放集成。

  <Expandable title="integrations.logrocket">
    <ResponseField name="appId" type="string" required>
      你的 LogRocket 应用 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.mixpanel" type="object">
  Mixpanel 产品分析集成。

  <Expandable title="integrations.mixpanel">
    <ResponseField name="projectToken" type="string" required>
      你的 Mixpanel 项目 token。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.pirsch" type="object">
  Pirsch 隐私友好型分析集成。

  <Expandable title="integrations.pirsch">
    <ResponseField name="id" type="string" required>
      你的 Pirsch 站点 ID。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.plausible" type="object">
  Plausible 隐私友好型分析集成。

  <Expandable title="integrations.plausible">
    <ResponseField name="domain" type="string" required>
      你的 Plausible 域名。
    </ResponseField>
    <ResponseField name="server" type="string">
      如果自托管，你的 Plausible 服务器。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.posthog" type="object">
  PostHog 产品分析集成。

  <Expandable title="integrations.posthog">
    <ResponseField name="apiKey" type="string 匹配 ^phc_" required>
      你的 PostHog API key。必须以 `phc_` 开头。
    </ResponseField>
    <ResponseField name="apiHost" type="string (uri)">
      你的 PostHog API 主机。自托管 PostHog 时必需。
    </ResponseField>
    <ResponseField name="sessionRecording" type="boolean">
      是否启用会话录制。默认为 `false`。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.segment" type="object">
  Segment 客户数据平台集成。

  <Expandable title="integrations.segment">
    <ResponseField name="key" type="string" required>
      你的 Segment write key。
    </ResponseField>
  </Expandable>
</ResponseField>

### 聊天和支持

<ResponseField name="integrations.frontchat" type="object">
  Front 聊天小部件集成。

  <Expandable title="integrations.frontchat">
    <ResponseField name="snippetId" type="string" required>
      你的 Front 聊天代码片段 ID。最小长度：6。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.intercom" type="object">
  Intercom 客户消息集成。

  <Expandable title="integrations.intercom">
    <ResponseField name="appId" type="string" required>
      你的 Intercom 应用 ID。最小长度：6。
    </ResponseField>
  </Expandable>
</ResponseField>

### 数据增强

<ResponseField name="integrations.clearbit" type="object">
  Clearbit 访客数据增强集成。

  <Expandable title="integrations.clearbit">
    <ResponseField name="publicApiKey" type="string" required>
      你的 Clearbit 公开 API key。
    </ResponseField>
  </Expandable>
</ResponseField>

### 平台设置

<ResponseField name="integrations.telemetry" type="object">
  Mintlify 遥测设置。

  <Expandable title="integrations.telemetry">
    <ResponseField name="enabled" type="boolean">
      是否启用 Mintlify 遥测。当设置为 `false` 时，反馈功能也会被禁用，不会显示在文档页面上。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="integrations.cookies" type="object">
  文档站点的 cookie 设置。

  <Expandable title="integrations.cookies">
    <ResponseField name="key" type="string">
      Cookie 键名。
    </ResponseField>
    <ResponseField name="value" type="string">
      Cookie 值。
    </ResponseField>
  </Expandable>
</ResponseField>

## 示例

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