Intégrations Analytics

Connectez-vous aux plateformes d’analytics pour suivre l’engagement des utilisateurs et l’usage de la documentation.

Suivez la manière dont les utilisateurs interagissent avec votre documentation en la connectant à des plateformes d’analytics tierces. Mintlify envoie des événements d’engagement à vos fournisseurs d’analytics configurés.

​

Fonctionnement des intégrations Analytics

Lorsque vous ajoutez des intégrations Analytics à votre site de documentation, Mintlify suit les interactions des utilisateurs comme les pages vues, les requêtes de recherche, les requêtes du bac à sable d’API et les envois de retours, puis les envoie à vos plateformes d’Analytics. Vous pouvez connecter autant de plateformes d’Analytics prises en charge que vous le souhaitez en ajoutant vos clés d’API au fichier docs.json. Les événements Analytics sont transmis à vos plateformes dès que vous les ajoutez à votre configuration, sans configuration supplémentaire requise.

​

Plateformes prises en charge

Amplitude

Mixpanel

Clarté

PostHog

Google Analytics 4

Google Tag Manager

Hightouch

Hotjar

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

​

Configuration

Ajoutez les identifiants de votre fournisseur d’Analytics à l’objet integrations dans docs.json. N’ajoutez que les plateformes que vous souhaitez utiliser.

Les intégrations Analytics ne nécessitent que des clés d’API publiques, qui sont accessibles à toute personne consultant votre site de documentation. Vos clés d’API privées, qui sont associées aux clés publiques du côté des fournisseurs d’Analytics, doivent rester privées. N’incluez pas de clés d’API privées dans votre docs.json.

docs.json

"integrations": {
    "amplitude": {
        "apiKey": "required"
    },
    "clarity": {
        "projectId": "required"
    },
    "clearbit": {
        "publicApiKey": "required"
    },
    "cookies": {
      "key": "required",
      "value": "required"
    },
    "fathom": {
        "siteId": "required"
    },
    "ga4": {
        "measurementId": "required"
    },
    "gtm": {
        "tagId": "required"
    },
    "hightouch": {
        "apiKey": "required",
        "apiHost": "optionnel"
    },
    "hotjar": {
        "hjid": "required",
        "hjsv": "required"
    },
    "logrocket": {
        "appId": "required"
    },
    "mixpanel": {
        "projectToken": "required"
    },
    "pirsch": {
        "id": "required"
    },
    "plausible": {
        "domain": "required"
    },
    "posthog": {
        "apiKey": "required",
        "apiHost": "optionnel"
    },
    "segment": {
      "key": "required"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

​

Exemple de configuration

docs.json

{
  "integrations": {
    "ga4": {
      "measurementId": "G-XXXXXXXXXX"
    },
    "posthog": {
      "apiKey": "phc_xxxxxxxxxxxxx",
      "apiHost": "https://app.posthog.com"
    },
    "mixpanel": {
      "projectToken": "xxxxxxxxxxxxx"
    }
  }
}

​

Événements suivis

Tous ces événements utilisent le préfixe docs..

​

Navigation et vues de page

Nom de l’événement	Description
docs.content.view	Lorsqu’un utilisateur consulte une page. Uniquement disponible pour les fournisseurs d’Analytics qui ne suivent pas les vues de page par défaut.
docs.content.md.view	Lorsqu’un utilisateur consulte la version Markdown d’une page.
docs.navitem.click	Lorsqu’un utilisateur clique sur un élément de navigation de l’en-tête.
docs.navitem.cta_click	Lorsqu’un utilisateur clique sur un bouton d’appel à l’action.
docs.footer.powered_by_mintlify_click	Lorsqu’un utilisateur clique sur le lien « Powered by Mintlify ».

​

Recherche

Nom de l’événement	Description
docs.search.query	Lorsqu’un utilisateur effectue une requête de recherche.
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.

​

Code et bac à sable d’API

Nom de l’événement	Description
docs.code_block.copy	Lorsqu’un utilisateur copie du code à partir d’un bloc de code.
docs.code_block.ask_ai	Lorsqu’un utilisateur demande à l’Assistant d’expliquer un bloc de code.
docs.api_playground.request	Lorsqu’un utilisateur appelle une API dans le bac à sable d’API.

​

Composants interactifs

Nom de l’événement	Description
docs.accordion.open	Un utilisateur ouvre un Accordion.
docs.accordion.close	Un utilisateur ferme un Accordion.
docs.expandable.open	Un utilisateur ouvre une section extensible.
docs.expandable.close	Un utilisateur ferme une section extensible.

​

Assistant et agent

Nom de l’événement	Description
docs.assistant.enter	Lorsqu’un utilisateur démarre un chat.
docs.assistant.completed	Lorsqu’une session de chat est terminée.
docs.assistant.source_click	Lorsqu’un utilisateur clique sur une citation dans un chat.
docs.assistant.suggestion_click	Lorsqu’un utilisateur clique sur une suggestion dans un chat.
docs.assistant.ask_ai_on_text_selection	Lorsqu’un utilisateur sélectionne du texte et clique sur « Ask AI » pour poser une question à propos de cette sélection.
docs.assistant.shared	Lorsqu’un utilisateur partage une conversation de chat.
docs.assistant.thumbs_up	Lorsqu’un utilisateur clique sur le bouton d’avis positif sur une réponse de l’Assistant IA.
docs.assistant.thumbs_down	Lorsqu’un utilisateur clique sur le bouton d’avis négatif sur une réponse de l’Assistant IA.
docs.assistant.spam_detected	Lorsque l’Assistant IA détecte du spam dans un message d’utilisateur.
docs.autopilot.suggestion.created	Lorsque l’agent crée une suggestion de mise à jour de la documentation.
docs.autopilot.suggestion.no_suggestion	Lorsque l’agent détermine qu’aucune mise à jour de la documentation n’est nécessaire.

​

Menu contextuel

Nom de l’événement	Description
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 avec la page actuelle comme contexte.
docs.context_menu.install_mcp_server	Lorsqu’un utilisateur installe le serveur MCP hébergé sur des éditeurs de code.