Intégrations

Connectez des plateformes d’analyse, des outils de chat et d’autres services tiers à votre site de documentation dans votre fichier docs.json.

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 :

docs.json

"integrations": {
  "ga4": {
    "measurementId": "G-XXXXXXXXXX"
  }
}

​

Analytics

integrations.adobe · object

Intégration Adobe Analytics.

Afficher integrations.adobe

launchUrl · string (uri) · requis

Votre URL de lancement Adobe Analytics.

integrations.amplitude · object

Intégration Amplitude Analytics.

Afficher integrations.amplitude

apiKey · string · requis

Votre clé d’API Amplitude.

integrations.clarity · object

Intégration Microsoft Clarity pour l’enregistrement de sessions et les cartes de chaleur.

Afficher integrations.clarity

projectId · string · requis

Votre identifiant de projet Microsoft Clarity.

integrations.fathom · object

Intégration Fathom Analytics.

Afficher integrations.fathom

siteId · string · requis

Votre identifiant de site Fathom.

integrations.ga4 · object

Intégration Google Analytics 4.

Afficher integrations.ga4

measurementId · string matching ^G · requis

Votre identifiant de mesure Google Analytics 4. Doit commencer par G.

integrations.gtm · object

Intégration Google Tag Manager.

Afficher integrations.gtm

tagId · string matching ^G · requis

Votre identifiant de conteneur Google Tag Manager. Doit commencer par G.

integrations.heap · object

Intégration Heap Analytics.

Afficher integrations.heap

appId · string · requis

Votre identifiant d’application Heap.

integrations.hightouch · object

Intégration d’activation de données Hightouch.

Afficher integrations.hightouch

writeKey · string · requis

Votre clé d’écriture Hightouch.

apiHost · string

Votre hôte d’API Hightouch.

integrations.hotjar · object

Intégration Hotjar pour les cartes de chaleur et l’enregistrement de sessions.

Afficher integrations.hotjar

hjid · string · requis

Votre identifiant de site Hotjar.

hjsv · string · requis

Votre version de script Hotjar.

integrations.logrocket · object

Intégration de replay de session LogRocket.

Afficher integrations.logrocket

appId · string · requis

Votre identifiant d’application LogRocket.

integrations.mixpanel · object

Intégration Mixpanel product analytics.

Afficher integrations.mixpanel

projectToken · string · requis

Votre token de projet Mixpanel.

integrations.pirsch · object

Intégration Pirsch, analytics respectueux de la vie privée.

Afficher integrations.pirsch

id · string · requis

Votre identifiant de site Pirsch.

integrations.plausible · object

Intégration Plausible, analytics respectueux de la vie privée.

Afficher integrations.plausible

domain · string · requis

Votre domaine Plausible.

server · string

Votre serveur Plausible, si auto-hébergé.

integrations.posthog · object

Intégration PostHog product analytics.

Afficher integrations.posthog

apiKey · string matching ^phc_ · requis

Votre clé d’API PostHog. Doit commencer par phc_.

apiHost · string (uri)

Votre hôte d’API PostHog. Requis si vous auto-hébergez PostHog.

sessionRecording · boolean

Indique s’il faut activer l’enregistrement de session. Valeur par défaut : false.

integrations.segment · object

Intégration Segment, plateforme de données client.

Afficher integrations.segment

key · string · requis

Votre clé d’écriture Segment.

​

Chat et support

integrations.frontchat · object

Intégration du widget de chat Front.

Afficher integrations.frontchat

snippetId · string · requis

Votre identifiant de snippet Front chat. Longueur minimale : 6.

integrations.intercom · object

Intégration de messagerie client Intercom.

Afficher integrations.intercom

appId · string · requis

Votre identifiant d’application Intercom. Longueur minimale : 6.

​

Enrichissement de données

integrations.clearbit · object

Intégration d’enrichissement de données visiteurs Clearbit.

Afficher integrations.clearbit

publicApiKey · string · requis

Votre clé d’API publique Clearbit.

​

Paramètres de la plateforme

integrations.telemetry · object

Paramètres de télémétrie Mintlify.

Afficher integrations.telemetry

enabled · 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.

integrations.cookies · object

Paramètres de cookies pour votre site de documentation.

Afficher integrations.cookies

key · string

Nom de la clé du cookie.

value · string

Valeur du cookie.

​

Exemple

docs.json

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