Intégrations

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

object

Intégration Adobe Analytics.

Afficher integrations.adobe

string (uri)

requis

Votre URL de lancement Adobe Analytics.

object

Intégration Amplitude Analytics.

Afficher integrations.amplitude

string

requis

Votre clé d’API Amplitude.

object

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

Afficher integrations.clarity

string

requis

Votre identifiant de projet Microsoft Clarity.

object

Intégration Fathom Analytics.

Afficher integrations.fathom

string

requis

Votre identifiant de site Fathom.

object

Intégration Google Analytics 4.

Afficher integrations.ga4

string matching ^G

requis

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

object

Intégration Google Tag Manager.

Afficher integrations.gtm

string matching ^G

requis

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

object

Intégration Heap Analytics.

Afficher integrations.heap

string

requis

Votre identifiant d’application Heap.

object

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

Afficher integrations.hightouch

string

requis

Votre clé d’écriture Hightouch.

string

Votre hôte d’API Hightouch.

object

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

Afficher integrations.hotjar

string

requis

Votre identifiant de site Hotjar.

string

requis

Votre version de script Hotjar.

object

Intégration de replay de session LogRocket.

Afficher integrations.logrocket

string

requis

Votre identifiant d’application LogRocket.

object

Intégration Mixpanel product analytics.

Afficher integrations.mixpanel

string

requis

Votre token de projet Mixpanel.

object

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

Afficher integrations.pirsch

string

requis

Votre identifiant de site Pirsch.

object

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

Afficher integrations.plausible

string

requis

Votre domaine Plausible.

string

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

object

Intégration PostHog product analytics.

Afficher integrations.posthog

string matching ^phc_

requis

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

string (uri)

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

boolean

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

object

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

Afficher integrations.segment

string

requis

Votre clé d’écriture Segment.

Chat et support

object

Intégration du widget de chat Front.

Afficher integrations.frontchat

string

requis

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

object

Intégration de messagerie client Intercom.

Afficher integrations.intercom

string

requis

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

Enrichissement de données

object

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

Afficher integrations.clearbit

string

requis

Votre clé d’API publique Clearbit.

Paramètres de la plateforme

object

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

Afficher integrations.telemetry

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.

object

Paramètres de cookies pour votre site de documentation.

Afficher integrations.cookies

string

Nom de la clé du cookie.

string

Valeur du cookie.

Exemple

docs.json

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

Prise en main

Organiser

Personnaliser

Créer du contenu

Documenter des API

Déployer

Optimisation

Paramètres

Analytics

Chat et support

Enrichissement de données

Paramètres de la plateforme

Exemple

​Paramètres

​Analytics

​Chat et support

​Enrichissement de données

​Paramètres de la plateforme

​Exemple

Paramètres

Analytics

Chat et support

Enrichissement de données

Paramètres de la plateforme

Exemple