Envoyez automatiquement des données sur l’engagement avec votre documentation à votre fournisseur analytique tiers.

Toutes les intégrations

Activer l’analytique

Renseignez vos clés d’analytique dans docs.json. Vous pouvez ajouter gratuitement un nombre illimité d’intégrations d’analytique. 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.
Options d’analytique dans 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"
    },
    "koala": {
        "publicApiKey": "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 d’analyse

Nous envoyons les événements suivants à votre fournisseur d’analyse. Tous les événements utilisent le préfixe docs..
Nom de l’événementDescription
docs.accordion.closeLorsqu’un utilisateur ferme un accordéon.
docs.accordion.openLorsqu’un utilisateur ouvre un accordéon.
docs.api_playground.requestLorsqu’un utilisateur appelle une API dans le bac à sable API.
docs.code_block.copyLorsqu’un utilisateur copie du code depuis un bloc de code.
docs.code_block.ask_aiLorsqu’un utilisateur demande à l’Assistant d’expliquer un bloc de code.
docs.content.viewLorsqu’un utilisateur consulte une page. Disponible uniquement pour les fournisseurs d’analyse qui ne suivent pas les pages vues 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 ferme un élément extensible.
docs.expandable.openLorsqu’un utilisateur ouvre un élément extensible.
docs.navitem.clickLorsqu’un utilisateur clique sur un élément de navigation d’en-tête.
docs.footer.powered_by_mintlify_clickLorsqu’un utilisateur clique sur le lien « Powered by 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 initie 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 en utilisant la page actuelle comme contexte.
docs.context_menu.install_mcp_serverLorsqu’un utilisateur installe le serveur MCP hébergé dans des éditeurs de code.