Passer au contenu principal
Envoyez automatiquement des données sur l’engagement de votre documentation à votre fournisseur d’analytics tiers.

Toutes les intégrations

Activation des Analytics

Définissez vos keys d’Analytics dans docs.json. Vous pouvez ajouter un nombre illimité d’intégrations Analytics gratuitement. La syntaxe de docs.json est présentée ci-dessous. Vous n’avez besoin d’inclure que les entrées des plateformes que vous souhaitez connecter.
Analytics options in docs.json
"integrations": {
    "amplitude": {
        "apiKey": "required"
    },
    "clearbit": {
        "publicApiKey": "required"
    },
    "cookies": {
      "key": "required",
      "value": "required"
    },
    "fathom": {
        "siteId": "required"
    },
    "ga4": {
        "measurementId": "required"
    },
    "gtm": {
        "tagId": "required"
    },
    "hightouch": {
        "apiKey": "required",
        "apiHost": "optional"
    },
    "hotjar": {
        "hjid": "required",
        "hjsv": "required"
    },
    "logrocket": {
        "appId": "required"
    },
    "mixpanel": {
        "projectToken": "required"
    },
    "pirsch": {
        "id": "required"
    },
    "plausible": {
        "domain": "required"
    },
    "posthog": {
        "apiKey": "required",
        "apiHost": "optional"
    },
    "segment": {
      "key": "required"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

Événements Analytics

Nous envoyons les événements suivants à votre fournisseur d’Analytics. Tous les événements utilisent le préfixe docs..
Event nameDescription
docs.accordion.closeLorsqu’un utilisateur referme un Accordion.
docs.accordion.openLorsqu’un utilisateur ouvre un Accordion.
docs.api_playground.requestLorsqu’un utilisateur appelle une API dans le bac à sable d’API.
docs.code_block.copyLorsqu’un utilisateur copie du code depuis un code block.
docs.code_block.ask_aiLorsqu’un utilisateur demande à l’Assistant d’expliquer un code block.
docs.content.viewLorsqu’un utilisateur consulte une page. Disponible uniquement pour les fournisseurs d’Analytics qui ne suivent pas les vues de page par défaut.
docs.feedback.thumbs_upLorsqu’un utilisateur clique sur le bouton d’avis positif.
docs.feedback.thumbs_downLorsqu’un utilisateur clique sur le bouton d’avis négatif.
docs.navitem.cta_clickLorsqu’un utilisateur clique sur un appel à l’action.
docs.expandable.closeLorsqu’un utilisateur referme un panneau déroulant.
docs.expandable.openLorsqu’un utilisateur ouvre un panneau déroulant.
docs.navitem.clickLorsqu’un utilisateur clique sur un élément de navigation de l’en‑tête.
docs.footer.powered_by_mintlify_clickLorsqu’un utilisateur clique sur le lien « Propulsé par Mintlify ».
docs.assistant.source_clickLorsqu’un utilisateur clique sur une citation dans une conversation.
docs.assistant.suggestion_clickLorsqu’un utilisateur clique sur une suggestion dans une conversation.
docs.assistant.thumbs_upLorsqu’un utilisateur clique sur le bouton d’avis positif dans une conversation.
docs.assistant.thumbs_downLorsqu’un utilisateur clique sur le bouton d’avis négatif dans une conversation.
docs.assistant.completedLorsqu’une session de conversation est terminée.
docs.assistant.enterLorsqu’un utilisateur lance une conversation.
docs.assistant.sharedLorsqu’un utilisateur partage une conversation.
docs.search.closeLorsqu’un utilisateur ferme la barre de recherche.
docs.search.result_clickLorsqu’un utilisateur clique sur un résultat de recherche.
docs.context_menu.copy_pageLorsqu’un utilisateur copie la page actuelle en Markdown.
docs.context_menu.copy_mcp_linkLorsqu’un utilisateur copie le lien du serveur MCP hébergé.
docs.context_menu.ai_provider_clickLorsqu’un utilisateur clique sur un fournisseur d’IA et crée une conversation avec la page actuelle comme context.
docs.context_menu.install_mcp_serverLorsqu’un utilisateur installe le serveur MCP hébergé dans des éditeurs de code.
I