Intégrations Analytics

Intégrez une plateforme d’analytics pour suivre les événements

Envoyez automatiquement des données sur l’engagement vis‑à‑vis de votre documentation à votre fournisseur d’analytics tiers.

​

Toutes les intégrations

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google Tag Manager

Hightouch

Hotjar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​

Activation des 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. Vous n’avez à 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"
    },
    "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 Analytics

Nous envoyons les événements suivants à votre fournisseur Analytics. Tous les événements utilisent le préfixe docs..

Nom de l’événement	Description
docs.accordion.close	Lorsqu’un utilisateur referme un Accordion.
docs.accordion.open	Lorsqu’un utilisateur ouvre un Accordion.
docs.api_playground.request	Lorsqu’un utilisateur appelle une API dans le bac à sable d’API.
docs.code_block.copy	Lorsqu’un utilisateur copie du code depuis un code block.
docs.code_block.ask_ai	Lorsqu’un utilisateur demande à l’Assistant d’expliquer un code block.
docs.content.view	Lorsqu’un utilisateur consulte une page. Disponible uniquement pour les fournisseurs Analytics qui ne suivent pas les vues de page par défaut.
docs.feedback.thumbs_up	Lorsqu’un utilisateur clique sur le bouton d’avis positif.
docs.feedback.thumbs_down	Lorsqu’un utilisateur clique sur le bouton d’avis négatif.
docs.navitem.cta_click	Lorsqu’un utilisateur clique sur un appel à l’action.
docs.expandable.close	Lorsqu’un utilisateur ferme un élément déroulant.
docs.expandable.open	Lorsqu’un utilisateur ouvre un élément déroulant.
docs.navitem.click	Lorsqu’un utilisateur clique sur un élément de navigation d’en-tête.
docs.footer.powered_by_mintlify_click	Lorsqu’un utilisateur clique sur le lien « Powered by Mintlify ».
docs.assistant.source_click	Lorsqu’un utilisateur clique sur une citation dans une conversation.
docs.assistant.suggestion_click	Lorsqu’un utilisateur clique sur une suggestion dans une conversation.
docs.assistant.thumbs_up	Lorsqu’un utilisateur clique sur le bouton d’avis positif dans une conversation.
docs.assistant.thumbs_down	Lorsqu’un utilisateur clique sur le bouton d’avis négatif dans une conversation.
docs.assistant.completed	Lorsqu’une session de conversation est terminée.
docs.assistant.enter	Lorsqu’un utilisateur lance une conversation.
docs.assistant.shared	Lorsqu’un utilisateur partage une conversation.
docs.search.close	Lorsqu’un utilisateur ferme la barre de recherche.
docs.search.result_click	Lorsqu’un utilisateur clique sur un résultat de recherche.
docs.context_menu.copy_page	Lorsqu’un utilisateur copie la page actuelle en Markdown.
docs.context_menu.copy_mcp_link	Lorsqu’un utilisateur copie le lien du serveur MCP hébergé.
docs.context_menu.ai_provider_click	Lorsqu’un utilisateur clique sur un fournisseur d’IA et crée une conversation en utilisant la page actuelle comme context.
docs.context_menu.install_mcp_server	Lorsqu’un utilisateur installe le serveur MCP hébergé dans des éditeurs de code.