mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
4b465465dd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
266 lines
8.1 KiB
Plaintext
266 lines
8.1 KiB
Plaintext
---
|
|
title: "Intégrations"
|
|
description: "Connectez des plateformes d'analyse, des widgets de chat et des services tiers à votre site de documentation Mintlify via la configuration des intégrations dans docs.json."
|
|
keywords: ["integrations", "analytics", "google analytics", "posthog", "segment", "intercom", "hotjar", "mixpanel", "amplitude", "docs.json"]
|
|
boost: 3
|
|
---
|
|
|
|
Utilisez le champ `integrations` dans `docs.json` pour connecter des plateformes d'analyse tierces, des outils de chat et d'autres services à votre site de documentation.
|
|
|
|
## Paramètres
|
|
|
|
Configurez toutes les intégrations comme propriétés de l'objet `integrations` dans votre fichier `docs.json` :
|
|
|
|
```json docs.json
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-XXXXXXXXXX"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Analytics
|
|
|
|
<ResponseField name="integrations.adobe" type="object">
|
|
Intégration Adobe Analytics.
|
|
|
|
<Expandable title="integrations.adobe">
|
|
<ResponseField name="launchUrl" type="string (uri)" required>
|
|
Votre URL de lancement Adobe Analytics.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.amplitude" type="object">
|
|
Intégration Amplitude Analytics.
|
|
|
|
<Expandable title="integrations.amplitude">
|
|
<ResponseField name="apiKey" type="string" required>
|
|
Votre clé d'API Amplitude.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.clarity" type="object">
|
|
Intégration Microsoft Clarity pour l'enregistrement de sessions et les cartes de chaleur.
|
|
|
|
<Expandable title="integrations.clarity">
|
|
<ResponseField name="projectId" type="string" required>
|
|
Votre identifiant de projet Microsoft Clarity.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.fathom" type="object">
|
|
Intégration Fathom Analytics.
|
|
|
|
<Expandable title="integrations.fathom">
|
|
<ResponseField name="siteId" type="string" required>
|
|
Votre identifiant de site Fathom.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.ga4" type="object">
|
|
Intégration Google Analytics 4.
|
|
|
|
<Expandable title="integrations.ga4">
|
|
<ResponseField name="measurementId" type="string matching ^G" required>
|
|
Votre identifiant de mesure Google Analytics 4. Doit commencer par `G`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.gtm" type="object">
|
|
Intégration Google Tag Manager.
|
|
|
|
<Expandable title="integrations.gtm">
|
|
<ResponseField name="tagId" type="string matching ^G" required>
|
|
Votre identifiant de conteneur Google Tag Manager. Doit commencer par `G`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.heap" type="object">
|
|
Intégration Heap Analytics.
|
|
|
|
<Expandable title="integrations.heap">
|
|
<ResponseField name="appId" type="string" required>
|
|
Votre identifiant d'application Heap.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.hightouch" type="object">
|
|
Intégration d'activation de données Hightouch.
|
|
|
|
<Expandable title="integrations.hightouch">
|
|
<ResponseField name="writeKey" type="string" required>
|
|
Votre clé d'écriture Hightouch.
|
|
</ResponseField>
|
|
<ResponseField name="apiHost" type="string">
|
|
Votre hôte d'API Hightouch.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.hotjar" type="object">
|
|
Intégration Hotjar pour les cartes de chaleur et l'enregistrement de sessions.
|
|
|
|
<Expandable title="integrations.hotjar">
|
|
<ResponseField name="hjid" type="string" required>
|
|
Votre identifiant de site Hotjar.
|
|
</ResponseField>
|
|
<ResponseField name="hjsv" type="string" required>
|
|
Votre version de script Hotjar.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.logrocket" type="object">
|
|
Intégration de replay de session LogRocket.
|
|
|
|
<Expandable title="integrations.logrocket">
|
|
<ResponseField name="appId" type="string" required>
|
|
Votre identifiant d'application LogRocket.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.mixpanel" type="object">
|
|
Intégration Mixpanel product analytics.
|
|
|
|
<Expandable title="integrations.mixpanel">
|
|
<ResponseField name="projectToken" type="string" required>
|
|
Votre token de projet Mixpanel.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.pirsch" type="object">
|
|
Intégration Pirsch, analytics respectueux de la vie privée.
|
|
|
|
<Expandable title="integrations.pirsch">
|
|
<ResponseField name="id" type="string" required>
|
|
Votre identifiant de site Pirsch.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.plausible" type="object">
|
|
Intégration Plausible, analytics respectueux de la vie privée.
|
|
|
|
<Expandable title="integrations.plausible">
|
|
<ResponseField name="domain" type="string" required>
|
|
Votre domaine Plausible.
|
|
</ResponseField>
|
|
<ResponseField name="server" type="string">
|
|
Votre serveur Plausible, si auto-hébergé.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.posthog" type="object">
|
|
Intégration PostHog product analytics.
|
|
|
|
<Expandable title="integrations.posthog">
|
|
<ResponseField name="apiKey" type="string matching ^phc_" required>
|
|
Votre clé d'API PostHog. Doit commencer par `phc_`.
|
|
</ResponseField>
|
|
<ResponseField name="apiHost" type="string (uri)">
|
|
Votre hôte d'API PostHog. Requis si vous auto-hébergez PostHog.
|
|
</ResponseField>
|
|
<ResponseField name="sessionRecording" type="boolean">
|
|
Indique s'il faut activer l'enregistrement de session. Valeur par défaut : `false`.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.segment" type="object">
|
|
Intégration Segment, plateforme de données client.
|
|
|
|
<Expandable title="integrations.segment">
|
|
<ResponseField name="key" type="string" required>
|
|
Votre clé d'écriture Segment.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Chat et support
|
|
|
|
<ResponseField name="integrations.frontchat" type="object">
|
|
Intégration du widget de chat Front.
|
|
|
|
<Expandable title="integrations.frontchat">
|
|
<ResponseField name="snippetId" type="string" required>
|
|
Votre identifiant de snippet Front chat. Longueur minimale : 6.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.intercom" type="object">
|
|
Intégration de messagerie client Intercom.
|
|
|
|
<Expandable title="integrations.intercom">
|
|
<ResponseField name="appId" type="string" required>
|
|
Votre identifiant d'application Intercom. Longueur minimale : 6.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Enrichissement de données
|
|
|
|
<ResponseField name="integrations.clearbit" type="object">
|
|
Intégration d'enrichissement de données visiteurs Clearbit.
|
|
|
|
<Expandable title="integrations.clearbit">
|
|
<ResponseField name="publicApiKey" type="string" required>
|
|
Votre clé d'API publique Clearbit.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
### Paramètres de la plateforme
|
|
|
|
<ResponseField name="integrations.telemetry" type="object">
|
|
Paramètres de télémétrie Mintlify.
|
|
|
|
<Expandable title="integrations.telemetry">
|
|
<ResponseField name="enabled" type="boolean">
|
|
Indique s'il faut activer la télémétrie Mintlify. Lorsque défini sur `false`, les fonctionnalités de feedback sont également désactivées et n'apparaissent pas sur les pages de votre documentation.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
<ResponseField name="integrations.cookies" type="object">
|
|
Paramètres de cookies pour votre site de documentation.
|
|
|
|
<Expandable title="integrations.cookies">
|
|
<ResponseField name="key" type="string">
|
|
Nom de la clé du cookie.
|
|
</ResponseField>
|
|
<ResponseField name="value" type="string">
|
|
Valeur du cookie.
|
|
</ResponseField>
|
|
</Expandable>
|
|
</ResponseField>
|
|
|
|
## Exemple
|
|
|
|
```json docs.json
|
|
"integrations": {
|
|
"ga4": {
|
|
"measurementId": "G-XXXXXXXXXX"
|
|
},
|
|
"posthog": {
|
|
"apiKey": "phc_XXXXXXXXXX"
|
|
},
|
|
"intercom": {
|
|
"appId": "abc12345"
|
|
},
|
|
"telemetry": {
|
|
"enabled": true
|
|
}
|
|
}
|
|
```
|