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

Toutes les intégrations

Activer les Analytics

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

Événements Analytics

Nous envoyons les événements suivants à votre fournisseur d’Analytics. Tous les événements utilisent le préfixe docs..
Nom de l’événementDescription
docs.accordion.closeLorsqu’un utilisateur ferme 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 à partir d’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. Uniquement disponible 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 ferme une section extensible.
docs.expandable.openLorsqu’un utilisateur ouvre une section extensible.
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 « Powered by Mintlify ».
docs.assistant.source_clickLorsqu’un utilisateur clique sur une citation dans un chat.
docs.assistant.suggestion_clickLorsqu’un utilisateur clique sur une suggestion dans un chat.
docs.assistant.thumbs_upLorsqu’un utilisateur clique sur le bouton d’avis positif dans un chat.
docs.assistant.thumbs_downLorsqu’un utilisateur clique sur le bouton d’avis négatif dans un chat.
docs.assistant.completedLorsqu’une session de chat est terminée.
docs.assistant.enterLorsqu’un utilisateur démarre un chat.
docs.assistant.ask_ai_on_text_selectionLorsqu’un utilisateur sélectionne du texte et clique sur « Ask AI » pour poser une question à propos de cette sélection.
docs.assistant.sharedLorsqu’un utilisateur partage une conversation de chat.
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 contexte.
docs.context_menu.install_mcp_serverLorsqu’un utilisateur installe le serveur MCP hébergé sur des éditeurs de code.