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
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.
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.
"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"
}
}
{
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"
},
"posthog": {
"apiKey": "phc_xxxxxxxxxxxxx",
"apiHost": "https://app.posthog.com"
},
"mixpanel": {
"projectToken": "xxxxxxxxxxxxx"
}
}
}
docs..
Navegación y vistas de página
| 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”. |
| 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. |
| 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. |
| 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. |
