Integraciones de Analytics

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 Analytics

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

Adobe Analytics

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

Hightouch

Hotjar

LogRocket

Microsoft Clarity

Mixpanel

Pirsch

Plausible

PostHog

Segment

Configuración

Configura las credenciales de tu proveedor de Analytics en el objeto integrations de docs.json. Incluye solo las plataformas que deseas usar.

Las integraciones de Analytics solo requieren claves públicas de API, que son accesibles para cualquier persona que vea tu sitio de documentación. Tus claves privadas de API, que se emparejan con las claves públicas en el lado de los proveedores de Analytics, deben mantenerse privadas. No incluyas claves privadas de API en tu docs.json.

docs.json

"integrations": {
    "adobe": {
        "launchUrl": "obligatorio"
    },
    "amplitude": {
        "apiKey": "obligatorio"
    },
    "clarity": {
        "projectId": "obligatorio"
    },
    "clearbit": {
        "publicApiKey": "obligatorio"
    },
    "cookies": {
      "key": "obligatorio",
      "value": "obligatorio"
    },
    "fathom": {
        "siteId": "obligatorio"
    },
    "ga4": {
        "measurementId": "obligatorio"
    },
    "gtm": {
        "tagId": "obligatorio"
    },
    "heap": {
        "appId": "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"
    }
  }
}

Verifica tu configuración

Después de desplegar el docs.json actualizado, comprueba que los eventos están llegando a tu proveedor de Analytics:

Despliega tus cambios. Los eventos de Analytics solo comienzan a fluir después de que los cambios en tu docs.json se despliegan en tu sitio en producción. Las sesiones locales de mint dev no envían eventos.
Activa un evento. Visita tu sitio en producción e interactúa con él. Consulta una página, realiza una búsqueda o envía una solicitud en el área de pruebas de la API para generar uno de los eventos rastreados.
Consulta la vista en tiempo real de tu proveedor. La mayoría de las plataformas muestran los eventos entrantes en menos de un minuto:
- Google Analytics 4: Reports → Realtime.
- PostHog: Activity → Live events.
- Mixpanel: Events → Live view.
- Amplitude: Data → Live event stream.
Desactiva los bloqueadores de anuncios. Extensiones del navegador como uBlock Origin y Privacy Badger bloquean muchos scripts de Analytics de forma predeterminada. Prueba en una ventana de incógnito con las extensiones desactivadas si los eventos no aparecen.

Si los eventos siguen sin llegar, verifica de nuevo que estás usando el tipo de clave correcto para cada proveedor (consulta la nota en Configuración) y que los cambios en tu docs.json se han desplegado correctamente.

Eventos rastreados

Todos los eventos de seguimiento utilizan el prefijo docs..

Event name	Descripción
`docs.content.view`	Cuando 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.content.md.view`	Cuando un usuario ve la versión en Markdown de una página.
`docs.navitem.click`	Cuando un usuario hace clic en un elemento de navegación del encabezado.
`docs.navitem.cta_click`	Cuando un usuario hace clic en un botón de llamada a la acción.
`docs.footer.powered_by_mintlify_click`	Cuando un usuario hace clic en el enlace “Powered by Mintlify”.

Búsqueda

Event name	Descripción
`docs.search.query`	Cuando un usuario realiza una búsqueda.
`docs.search.close`	Cuando un usuario cierra la barra de búsqueda.
`docs.search.result_click`	Cuando un usuario hace clic en un resultado de búsqueda.

Código y área de pruebas de la API

Event name	Descripción
`docs.code_block.copy`	El usuario copia el código de un bloque de código.
`docs.code_block.ask_ai`	El usuario le pide al assistant que explique un bloque de código.
`docs.api_playground.request`	El usuario realiza una solicitud a una API en el área de pruebas de la API.

Componentes interactivos

Event name	Descripción
`docs.accordion.open`	El usuario abre un Accordion.
`docs.accordion.close`	El usuario cierra un Accordion.
`docs.expandable.open`	El usuario abre un elemento expandible.
`docs.expandable.close`	El usuario cierra un elemento expandible.

Asistente de IA y agente

Event name	Descripción
`docs.assistant.enter`	Cuando un usuario abre el Asistente de IA.
`docs.assistant.completed`	Cuando se completa una sesión de chat.
`docs.assistant.source_click`	Cuando un usuario hace clic en una cita en una respuesta de chat.
`docs.assistant.suggestion_click`	Cuando un usuario hace clic en una pregunta sugerida.
`docs.assistant.ask_ai_on_text_selection`	Cuando un usuario selecciona texto y hace clic en “Ask AI”.
`docs.assistant.shared`	Cuando un usuario comparte una conversación de chat.
`docs.assistant.thumbs_up`	Cuando un usuario hace clic en el botón de comentarios positivos en una respuesta del Asistente de IA.
`docs.assistant.thumbs_down`	Cuando un usuario hace clic en el botón de comentarios negativos en una respuesta del Asistente de IA.
`docs.assistant.spam_detected`	Cuando el Asistente de IA detecta spam en un mensaje de usuario.
`docs.autopilot.suggestion.created`	Cuando el agente crea una sugerencia de documentación.
`docs.autopilot.suggestion.no_suggestion`	Cuando el agente determina que la documentación no necesita actualizarse.

Event name	Descripción
`docs.context_menu.copy_page`	Cuando un usuario copia la página actual como Markdown.
`docs.context_menu.copy_mcp_link`	Cuando un usuario copia el enlace del servidor MCP alojado.
`docs.context_menu.copy_add_mcp_command`	Cuando un usuario copia el comando `npx add-mcp` para instalar el servidor MCP.
`docs.context_menu.ai_provider_click`	Cuando 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_server`	Cuando un usuario instala el servidor MCP alojado en editores de código.

Primeros pasos

Organizar

Personalizar

Crear contenido

Documentar APIs

Desplegar

Optimizar

Integraciones de Analytics

Cómo funcionan las integraciones de Analytics

Plataformas compatibles

Adobe Analytics

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

Hightouch

Hotjar

LogRocket

Microsoft Clarity

Mixpanel

Pirsch

Plausible

PostHog

Segment

Configuración

Ejemplo de configuración

Verifica tu configuración

Eventos rastreados

Navegación y vistas de página

Búsqueda

Código y área de pruebas de la API

Componentes interactivos

Asistente de IA y agente

Menú contextual

​Cómo funcionan las integraciones de Analytics

​Plataformas compatibles

Adobe Analytics

Amplitude

Clearbit

Fathom

Google Analytics 4

Google Tag Manager

Heap

Hightouch

Hotjar

LogRocket

Microsoft Clarity

Mixpanel

Pirsch

Plausible

PostHog

Segment

​Configuración

​Ejemplo de configuración

​Verifica tu configuración

​Eventos rastreados

​Navegación y vistas de página

​Búsqueda

​Código y área de pruebas de la API

​Componentes interactivos

​Asistente de IA y agente

​Menú contextual

Cómo funcionan las integraciones de Analytics

Plataformas compatibles

Configuración

Ejemplo de configuración

Verifica tu configuración

Eventos rastreados

Navegación y vistas de página

Búsqueda

Código y área de pruebas de la API

Componentes interactivos

Asistente de IA y agente

Menú contextual