Transmite eventos de analíticas a Amazon S3
Configura la transmisión de analíticas Enterprise para enviar categorías de eventos desde tus deployments de Mintlify a Amazon S3 casi en tiempo real.
Las analíticas requieren un plan Pro o Enterprise. La transmisión de analíticas solo está disponible en planes Enterprise.
Transmite los eventos de analíticas a Amazon S3 casi en tiempo real para enviarlos a tu data warehouse o a pipelines de analíticas posteriores sin esperar a las exportaciones CSV.
Los administradores de la organización pueden agregar múltiples destinos, seleccionar qué categorías de eventos enviar y elegir desde qué deployments transmitir. La transmisión de analíticas utiliza un modelo de inclusión: no se transmite ningún evento hasta que selecciones al menos una categoría y un deployment. Las mismas selecciones de categoría y deployment se aplican a todos los destinos.
- Ve a la página de Streaming de tu dashboard.
- En la sección Stream configuration, selecciona Configure.
- Selecciona Add destination.
- Ingresa una etiqueta opcional y luego proporciona el bucket de Amazon S3, la región de AWS, el access key ID y la secret access key. Opcionalmente, ingresa un prefijo que Mintlify añadirá al principio de cada clave de objeto.
- Selecciona Add destination.
Para dejar de transmitir a un destino, abre la configuración de streaming, selecciona el ícono de eliminar junto al destino y luego selecciona Remove para confirmar.
-
Ve a la página de Streaming de tu dashboard.
-
En la sección Stream configuration, selecciona Configure.
-
En la tabla de categorías, selecciona las categorías que quieres enviar.
Categoría Ejemplos Page views Eventos de vistas de páginas y de Markdown. Navigation Clics en elementos de navegación, clics en llamadas a la acción de navegación y cambios de versión. Search Consultas de búsqueda, clics en resultados, cierres de búsqueda y comparaciones de búsqueda. Page components Interacciones con elementos expandibles, acordeones, bloques de código y el API playground. Feedback Pulgar arriba, pulgar abajo y envíos de comentarios detallados. AI Assistant Conversaciones, fuentes, sugerencias, comentarios y errores del assistant. Context menu & MCP Acciones del menú contextual, copias de enlaces MCP, instalaciones de servidores MCP y llamadas a herramientas MCP. Los ejemplos resumen cada categoría. Usa el valor
eventTypetransmitido para identificar el evento exacto. -
Selecciona Save.
Selecciona cuáles de los deployments de tu organización envían eventos. El dashboard lista cada deployment por subdominio. Si creas un deployment, regresa a la configuración de streaming y selecciónalo. Los nuevos deployments no comienzan a transmitir eventos automáticamente.
- Ve a la página de Streaming de tu dashboard.
- En la sección Stream configuration, selecciona Configure.
- En la tabla de deployments, selecciona los deployments desde los que quieres enviar eventos.
- Selecciona Save.
No se transmite ningún evento hasta que selecciones al menos una categoría y un deployment.
Mintlify escribe objetos JSON delimitados por saltos de línea (.jsonl) en tu bucket. Mintlify genera los nombres de objeto a partir de marcas de tiempo UTC. Si configuras un prefijo de clave, Mintlify escribe los objetos bajo ese prefijo.
Cada línea contiene un envoltorio de evento con un eventType y un payload. El eventType es el nombre del evento, como docs.content.view. El payload contiene el evento de analíticas como un objeto JSON o como una cadena codificada en JSON. Si payload es una cadena, parséala como JSON antes de cargarla en tu warehouse.
El payload del evento contiene los siguientes campos:
| Campo | Descripción |
|---|---|
event_id | UUID que identifica el evento. Úsalo como clave de deduplicación al cargar los datos. |
subdomain | Subdominio del deployment que generó el evento. |
user_id | ID del usuario autenticado, cuando esté disponible. |
anon_id | ID anónimo del visitante, cuando esté disponible. |
session_id | ID de sesión del visitante o del assistant, cuando esté disponible. |
created_at | Marca de tiempo ISO 8601 de cuándo ocurrió el evento. |
event | Nombre del evento. Coincide con eventType en el envoltorio. |
path | Ruta de la documentación donde ocurrió el evento. |
referrer | URL de referencia, cuando esté disponible. |
user_agent | Cadena del user-agent del navegador o cliente. |
ip | Dirección IP del visitante. |
properties | Datos específicos del evento como un objeto JSON o una cadena codificada en JSON. |
Los cambios de configuración pueden tardar hasta un minuto en aplicarse.
Los eventos transmitidos pueden contener datos personales, incluidas direcciones IP, identificadores de usuarios y sesiones, consultas y respuestas del assistant, y comentarios o información de contacto de feedback. Aplica los controles de acceso, políticas de retención y otros requisitos de manejo de datos apropiados para tu organización.