跳转到主要内容
在你的 docs.json 文件中添加以下内容,以将 Analytics 发送到 PostHog。 仅在自托管 PostHog 时需要包含 apiHost。默认情况下,我们会将事件发送到 https://app.posthog.com
"integrations": {
    "posthog": {
        "apiKey": "YOUR_POSTHOG_PROJECT_API_KEY",
        "apiHost": "optional",
        "sessionRecording": true
    }
}

配置选项

apiKey
string
required
你的 PostHog 项目 API key。必须以 phc_ 开头。
apiHost
string
你的 PostHog 实例的 URL。仅在自托管 PostHog 时必填。默认为 https://app.posthog.com
sessionRecording
boolean
default:"true"
启用或禁用会话录制。将其设为 false 可在保持 Analytics 启用的同时禁用会话录制。

启用 PostHog 分析将会禁用 Mintlify 控制台中的 Analytics。

会话录制

在配置 PostHog 时,会话录制默认开启。若要在保持 Analytics 启用的情况下禁用会话录制,请在配置中将 sessionRecording 设置为 false
Disable session recordings
"integrations": {
    "posthog": {
        "apiKey": "phc_your-key",
        "sessionRecording": false
    }
}
在接收会话录制之前,你需要将文档网站的 URL 添加到 PostHog 的“录制授权域名”(Authorized domains for recordings)。添加 URL 的选项位于 PostHog 的项目设置中。