Intégrations

Connectez plateformes d’analyse, widgets de chat et services tiers à votre site de documentation Mintlify via la configuration des intégrations 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.adobeobject

Intégration Adobe Analytics.

Show integrations.adobe

launchUrlstring (uri)required

Votre URL de lancement Adobe Analytics.

integrations.amplitudeobject

Intégration Amplitude Analytics.

Show integrations.amplitude

apiKeystringrequired

Votre clé d’API Amplitude.

integrations.clarityobject

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

Show integrations.clarity

projectIdstringrequired

Votre identifiant de projet Microsoft Clarity.

integrations.fathomobject

Intégration Fathom Analytics.

Show integrations.fathom

siteIdstringrequired

Votre identifiant de site Fathom.

integrations.ga4object

Intégration Google Analytics 4.

Show integrations.ga4

measurementIdstring matching ^Grequired

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

integrations.gtmobject

Intégration Google Tag Manager.

Show integrations.gtm

tagIdstring matching ^Grequired

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

integrations.heapobject

Intégration Heap Analytics.

Show integrations.heap

appIdstringrequired

Votre identifiant d’application Heap.

integrations.hightouchobject

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

Show integrations.hightouch

writeKeystringrequired

Votre clé d’écriture Hightouch.

apiHoststring

Votre hôte d’API Hightouch.

integrations.hotjarobject

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

Show integrations.hotjar

hjidstringrequired

Votre identifiant de site Hotjar.

hjsvstringrequired

Votre version de script Hotjar.

integrations.logrocketobject

Intégration de replay de session LogRocket.

Show integrations.logrocket

appIdstringrequired

Votre identifiant d’application LogRocket.

integrations.mixpanelobject

Intégration Mixpanel product analytics.

Show integrations.mixpanel

projectTokenstringrequired

Votre token de projet Mixpanel.

integrations.pirschobject

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

Show integrations.pirsch

idstringrequired

Votre identifiant de site Pirsch.

integrations.plausibleobject

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

Show integrations.plausible

domainstringrequired

Votre domaine Plausible.

serverstring

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

integrations.posthogobject

Intégration PostHog product analytics.

Show integrations.posthog

apiKeystring matching ^phc_required

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

apiHoststring (uri)

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

sessionRecordingboolean

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

integrations.segmentobject

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

Show integrations.segment

keystringrequired

Votre clé d’écriture Segment.

Chat et support

integrations.frontchatobject

Intégration du widget de chat Front.

Show integrations.frontchat

snippetIdstringrequired

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

integrations.intercomobject

Intégration de messagerie client Intercom.

Show integrations.intercom

appIdstringrequired

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

Enrichissement de données

integrations.clearbitobject

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

Show integrations.clearbit

publicApiKeystringrequired

Votre clé d’API publique Clearbit.

Paramètres de la plateforme

integrations.telemetryobject

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

Show integrations.telemetry

enabledboolean

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.cookiesobject

Paramètres de cookies pour votre site de documentation.

Show integrations.cookies

keystring

Nom de la clé du cookie.

valuestring

Valeur du cookie.

Exemple

docs.json

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

Paramètres

Analytics

Chat et support

Enrichissement de données

Paramètres de la plateforme

Exemple

On this page