Saltar al contenido principal
Realiza un seguimiento de cómo los usuarios interactúan con tu documentación conectando plataformas de Analytics de terceros. Mintlify envía eventos de interacción a los proveedores de Analytics que hayas configurado.

Cómo funcionan las integraciones de analítica

Cuando agregas integraciones de Analytics a tu sitio de documentación, Mintlify registra interacciones de los usuarios como vistas de página, consultas de búsqueda, solicitudes en el área de pruebas de la API y envíos de comentarios, y las envía a tus proveedores de Analytics. Puedes conectar cualquier cantidad de proveedores de Analytics compatibles agregando tus claves de API al archivo docs.json. Los eventos de Analytics se envían a tus proveedores tan pronto como los agregas a tu configuración, sin necesidad de configuración adicional.

Plataformas compatibles

Configuración

Configura las credenciales de tu proveedor de Analytics en el objeto integrations de docs.json. Incluye solo las plataformas que deseas usar.
docs.json
"integrations": {
    "amplitude": {
        "apiKey": "obligatorio"
    },
    "clarity": {
        "projectId": "obligatorio"
    },
    "clearbit": {
        "publicApiKey": "obligatorio"
    },
    "cookies": {
      "key": "obligatorio",
      "value": "obligatorio"
    },
    "fathom": {
        "siteId": "obligatorio"
    },
    "ga4": {
        "measurementId": "obligatorio"
    },
    "gtm": {
        "tagId": "obligatorio"
    },
    "hightouch": {
        "apiKey": "obligatorio",
        "apiHost": "optional"
    },
    "hotjar": {
        "hjid": "obligatorio",
        "hjsv": "obligatorio"
    },
    "logrocket": {
        "appId": "obligatorio"
    },
    "mixpanel": {
        "projectToken": "obligatorio"
    },
    "pirsch": {
        "id": "obligatorio"
    },
    "plausible": {
        "domain": "obligatorio"
    },
    "posthog": {
        "apiKey": "obligatorio",
        "apiHost": "optional"
    },
    "segment": {
      "key": "obligatorio"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

Ejemplo de configuración

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

Eventos rastreados

Todos los eventos de seguimiento utilizan el prefijo docs..
Event nameDescripción
docs.content.viewCuando un usuario ve una página. Solo se envía a proveedores de analítica que no registran vistas de página de forma predeterminada.
docs.navitem.clickCuando un usuario hace clic en un elemento de navegación del encabezado.
docs.navitem.cta_clickCuando un usuario hace clic en un botón de llamada a la acción.
docs.footer.powered_by_mintlify_clickCuando un usuario hace clic en el enlace “Powered by Mintlify”.
Event nameDescripción
docs.search.closeCuando un usuario cierra la barra de búsqueda.
docs.search.result_clickCuando un usuario hace clic en un resultado de búsqueda.

Código y área de pruebas de la API

Event nameDescripción
docs.code_block.copyEl usuario copia el código de un bloque de código.
docs.code_block.ask_aiEl usuario le pide al assistant que explique un bloque de código.
docs.api_playground.requestEl usuario realiza una solicitud a una API en el área de pruebas de la API.

Componentes interactivos

Event nameDescripción
docs.accordion.openEl usuario abre un Accordion.
docs.accordion.closeEl usuario cierra un Accordion.
docs.expandable.openEl usuario abre un elemento expandible.
docs.expandable.closeEl usuario cierra un elemento expandible.

Asistente de IA y agente

Event nameDescripción
docs.assistant.enterCuando un usuario abre el Asistente de IA.
docs.assistant.completedCuando se completa una sesión de chat.
docs.assistant.source_clickCuando un usuario hace clic en una cita en una respuesta de chat.
docs.assistant.suggestion_clickCuando un usuario hace clic en una pregunta sugerida.
docs.assistant.ask_ai_on_text_selectionCuando un usuario selecciona texto y hace clic en “Ask AI”.
docs.assistant.sharedCuando un usuario comparte una conversación de chat.
docs.assistant.thumbs_upCuando un usuario hace clic en el botón de comentarios positivos en una respuesta del Asistente de IA.
docs.assistant.thumbs_downCuando un usuario hace clic en el botón de comentarios negativos en una respuesta del Asistente de IA.
docs.assistant.spam_detectedCuando el Asistente de IA detecta spam en un mensaje de usuario.
docs.autopilot.suggestion.createdCuando el agente crea una sugerencia de documentación.
docs.autopilot.suggestion.no_suggestionCuando el agente determina que no se necesita ninguna actualización de la documentación.

Menú contextual

Event nameDescripción
docs.context_menu.copy_pageCuando un usuario copia la página actual como Markdown.
docs.context_menu.copy_mcp_linkCuando un usuario copia el enlace del servidor MCP alojado.
docs.context_menu.ai_provider_clickCuando un usuario hace clic en un proveedor de IA para crear una conversación con la página actual como contexto.
docs.context_menu.install_mcp_serverCuando un usuario instala el servidor MCP alojado en editores de código.