mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
266 lines
7.6 KiB
Plaintext
266 lines
7.6 KiB
Plaintext
---
|
|
title: "Integrations"
|
|
description: "Connect analytics platforms, chat widgets, and third-party services to your Mintlify documentation site through the docs.json integrations config."
|
|
keywords: ["integrations", "analytics", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"]
|
|
boost: 3
|
|
---
|
|
|
|
Use the `integrations` field in `docs.json` to connect third-party analytics platforms, chat tools, and other services to your documentation site.
|
|
|
|
## Settings
|
|
|
|
Configure all integrations as properties of the `integrations` object in your `docs.json` file:
|
|
|
|
```json docs.json
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-XXXXXXXXXX"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Analytics
|
|
|
|
<ResponseField name="integrations.adobe" type="object">
|
|
Adobe Analytics integration.
|
|
|
|
<Expandable title="integrations.adobe">
|
|
<ResponseField name="launchUrl" type="string (uri)" required>
|
|
Your Adobe Analytics launch URL.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.amplitude" type="object">
|
|
Amplitude analytics integration.
|
|
|
|
<Expandable title="integrations.amplitude">
|
|
<ResponseField name="apiKey" type="string" required>
|
|
Your Amplitude API key.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.clarity" type="object">
|
|
Microsoft Clarity session recording and heatmap integration.
|
|
|
|
<Expandable title="integrations.clarity">
|
|
<ResponseField name="projectId" type="string" required>
|
|
Your Microsoft Clarity project ID.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.fathom" type="object">
|
|
Fathom analytics integration.
|
|
|
|
<Expandable title="integrations.fathom">
|
|
<ResponseField name="siteId" type="string" required>
|
|
Your Fathom site ID.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.ga4" type="object">
|
|
Google Analytics 4 integration.
|
|
|
|
<Expandable title="integrations.ga4">
|
|
<ResponseField name="measurementId" type="string matching ^G" required>
|
|
Your Google Analytics 4 measurement ID. Must begin with `G`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.gtm" type="object">
|
|
Google Tag Manager integration.
|
|
|
|
<Expandable title="integrations.gtm">
|
|
<ResponseField name="tagId" type="string matching ^G" required>
|
|
Your Google Tag Manager container ID. Must begin with `G`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.heap" type="object">
|
|
Heap analytics integration.
|
|
|
|
<Expandable title="integrations.heap">
|
|
<ResponseField name="appId" type="string" required>
|
|
Your Heap app ID.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.hightouch" type="object">
|
|
Hightouch data activation integration.
|
|
|
|
<Expandable title="integrations.hightouch">
|
|
<ResponseField name="writeKey" type="string" required>
|
|
Your Hightouch write key.
|
|
</ResponseField>
|
|
<ResponseField name="apiHost" type="string">
|
|
Your Hightouch API host.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.hotjar" type="object">
|
|
Hotjar heatmap and session recording integration.
|
|
|
|
<Expandable title="integrations.hotjar">
|
|
<ResponseField name="hjid" type="string" required>
|
|
Your Hotjar site ID.
|
|
</ResponseField>
|
|
<ResponseField name="hjsv" type="string" required>
|
|
Your Hotjar script version.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.logrocket" type="object">
|
|
LogRocket session replay integration.
|
|
|
|
<Expandable title="integrations.logrocket">
|
|
<ResponseField name="appId" type="string" required>
|
|
Your LogRocket app ID.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.mixpanel" type="object">
|
|
Mixpanel product analytics integration.
|
|
|
|
<Expandable title="integrations.mixpanel">
|
|
<ResponseField name="projectToken" type="string" required>
|
|
Your Mixpanel project token.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.pirsch" type="object">
|
|
Pirsch privacy-friendly analytics integration.
|
|
|
|
<Expandable title="integrations.pirsch">
|
|
<ResponseField name="id" type="string" required>
|
|
Your Pirsch site ID.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.plausible" type="object">
|
|
Plausible privacy-friendly analytics integration.
|
|
|
|
<Expandable title="integrations.plausible">
|
|
<ResponseField name="domain" type="string" required>
|
|
Your Plausible domain.
|
|
</ResponseField>
|
|
<ResponseField name="server" type="string">
|
|
Your Plausible server, if self-hosting.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.posthog" type="object">
|
|
PostHog product analytics integration.
|
|
|
|
<Expandable title="integrations.posthog">
|
|
<ResponseField name="apiKey" type="string matching ^phc_" required>
|
|
Your PostHog API key. Must begin with `phc_`.
|
|
</ResponseField>
|
|
<ResponseField name="apiHost" type="string (uri)">
|
|
Your PostHog API host. Required if self-hosting PostHog.
|
|
</ResponseField>
|
|
<ResponseField name="sessionRecording" type="boolean">
|
|
Whether to enable session recording. Defaults to `false`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.segment" type="object">
|
|
Segment customer data platform integration.
|
|
|
|
<Expandable title="integrations.segment">
|
|
<ResponseField name="key" type="string" required>
|
|
Your Segment write key.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Chat and support
|
|
|
|
<ResponseField name="integrations.frontchat" type="object">
|
|
Front chat widget integration.
|
|
|
|
<Expandable title="integrations.frontchat">
|
|
<ResponseField name="snippetId" type="string" required>
|
|
Your Front chat snippet ID. Minimum length: 6.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.intercom" type="object">
|
|
Intercom customer messaging integration.
|
|
|
|
<Expandable title="integrations.intercom">
|
|
<ResponseField name="appId" type="string" required>
|
|
Your Intercom app ID. Minimum length: 6.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Data enrichment
|
|
|
|
<ResponseField name="integrations.clearbit" type="object">
|
|
Clearbit visitor data enrichment integration.
|
|
|
|
<Expandable title="integrations.clearbit">
|
|
<ResponseField name="publicApiKey" type="string" required>
|
|
Your Clearbit public API key.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Platform settings
|
|
|
|
<ResponseField name="integrations.telemetry" type="object">
|
|
Mintlify telemetry settings.
|
|
|
|
<Expandable title="integrations.telemetry">
|
|
<ResponseField name="enabled" type="boolean">
|
|
Whether to enable Mintlify telemetry. When set to `false`, feedback features are also disabled and do not appear on your documentation pages.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.cookies" type="object">
|
|
Cookie settings for your documentation site.
|
|
|
|
<Expandable title="integrations.cookies">
|
|
<ResponseField name="key" type="string">
|
|
Cookie key name.
|
|
</ResponseField>
|
|
<ResponseField name="value" type="string">
|
|
Cookie value.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
## Example
|
|
|
|
```json docs.json
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-XXXXXXXXXX"
|
|
},
|
|
"posthog": {
|
|
"apiKey": "phc_XXXXXXXXXX"
|
|
},
|
|
"intercom": {
|
|
"appId": "abc12345"
|
|
},
|
|
"telemetry": {
|
|
"enabled": true
|
|
}
|
|
}
|
|
```
|