Este documento describe información detallada sobre los eventos de flujo. Si busca información sobre NPS y eventos de lista de verificación para una integración, consulte el documento de Referencia de eventos Appcues . Si desea obtener más información sobre el envío o el seguimiento de eventos en Appcues Appcues consulte el documento de Descripción general de eventos .

Tenemos tres niveles de eventos: flujo, grupo de pasos e hijastro. Los eventos de flujo corresponden al ciclo de vida general de un flujo, que se compone de grupos de pasos independientes. Los eventos de grupo de pasos describen el ciclo de vida de un grupo de pasos individual en un flujo. Un grupo de pasos suele incluir varios hijos. Los eventos de hijastro describen los detalles esenciales de lo que ocurre durante el proceso de mostrar e interactuar con un hijastro en particular.

Eventos de cara al público

• Flujo Iniciado ( flow_started ): Se activa cuando se inicia o se muestra en la página el primer paso de un flujo. Si se activa este evento, no se deben activar los eventos Flujo Abortado ni Error de Flujo. Debe activarse antes del evento Paso Iniciado.
• Flujo completado ( flow_completed ): Se activa cuando el usuario completa el último paso del flujo. Debe activarse después del evento "Paso completado".
• Flujo omitido ( flow_skipped ): Se activa cuando el usuario decide omitir un flujo. Debe activarse después de que se active el evento "Paso omitido" para el paso correspondiente.
• Flujo Abortado ( flow_aborted): Se activa cuando se produce un error fatal que impide iniciar o completar un flujo. Si este evento se activa antes del primer paso, no se debe activar "Flujo Iniciado". Debe activarse después del evento "Error de Flujo".
• Paso iniciado ( step_started ): Se activa cuando el grupo de pasos se ejecuta o se muestra en la página. Si se activa este evento, no se deben activar los eventos Paso cancelado ni Error de paso. Debe activarse antes de que se activen los eventos Paso hijo activado o Paso hijo recuperado.
• Paso completado ( step_completed ): Se activa cuando el usuario completa un grupo de pasos. Para modals y tooltips , esto significa cerrar el contenido con el botón "Completar". Para hotspots , esto significa hacer clic en el último hotspot . Debe activarse antes del evento "Flujo completado".
• Paso omitido ( step_skipped ): Se activa cuando el usuario decide omitir un grupo de pasos o un flujo. Debe activarse antes del evento "Flujo omitido".
• Paso Abortado ( step_aborted ): Se activa cuando se produce un error fatal que impide iniciar o completar un grupo de pasos. Si este evento se activa antes de mostrar el grupo de pasos, no se debe activar el evento "Paso Iniciado". Debe activarse antes del evento "Flujo Abortado".
• Paso Interactuado ( step_interacted ): Se activa cuando un usuario interactúa con un grupo de pasos de alguna manera. Actualmente, registramos cuándo un usuario realiza alguna de las siguientes acciones:
  • Hace clic en un enlace en un flujo
  • Hace clic en un botón (integrado o personalizado) en un flujo
  • Envía un formulario en un flujo
  • Hace clic en un hotspot para expandirlo. Debe activarse antes de los eventos de hijastro desactivado o hijastro activado que pueda desencadenar.
• Formulario enviado ( appcues:form_submitted ): Se activa cuando un usuario envía un formulario en un modal . Debe activarse antes del evento "Desactivación de hijastro" que podría activar y antes del evento "Campo de formulario enviado" que activará.
• Campo de formulario enviado ( appcues:form_field_submitted ): Se activa para cada campo de un formulario que el usuario envía en un modal . Debe activarse después del evento "Formulario enviado".

Eventos internos

Probablemente no deberías preocuparte por esto. Son eventos de nivel inferior que Appcues usa internamente para monitorear el rendimiento de los flujos. ¡Úsalos bajo tu propio riesgo!

• Intento de flujo ( flow_attempted ): Se activa cuando un usuario cumple los requisitos para un flujo y Appcues intenta iniciar el contenido. Esto generará un evento de "Flujo iniciado" o un evento de "Error de flujo". Este siempre debe ser el primer evento que se active para un flujo en particular.
• Error de flujo ( flow_error ): Se activa cuando se produce un error fatal que impide el inicio de un flujo. Si se activa este evento, no se debe activar "Flujo iniciado". Esto suele deberse a la aparición de un evento "Error de paso". Debe activarse antes del evento "Flujo cancelado".
• Paso intentado ( step_attempted ): Se activa cuando un usuario cumple los requisitos para un flujo y Appcues intenta iniciar un grupo de pasos específico. Esto generará un evento de "Paso iniciado" o "Error de paso". Este siempre debe ser el primer evento que se active para un grupo de pasos específico. Se activará para cada grupo de pasos de un flujo que Appcues intente iniciar.
• Error de paso ( step_error ): Se activa cuando se produce un error fatal que impide iniciar un grupo de pasos. Si se activa este evento, no se debe activar el evento "Paso iniciado". Debe activarse antes del evento "Paso cancelado".
• Activación de hijastro ( step_child_activated ): Se activa cuando el usuario visualiza correctamente el contenido de una hijastro específica. Por ejemplo: al visualizar una página específica en un modal ; al visualizar el contenido de una tooltip o hotspot (ya sea haciendo clic en el hotspot o en el botón "Siguiente"). Debería activarse después del evento "Interacción con el paso".
• Hijastro Desactivado ( step_child_deactivated ): Se activa cuando un usuario cierra o finaliza una hijastro en particular. Por ejemplo, al abandonar una página específica en un modal o cerrar una tooltip . Debería activarse después del evento "Interacción con el Paso".
• Error de hijo de paso ( step_child_error ): Se activa ante cualquier error que impida mostrar un hijo de paso específico. Dependiendo del tipo de contenido, puede provocar un error de paso grave. Debe activarse después de intentar un paso y antes de un error de paso (si este causa un error de paso).
• Hijastro Recuperado ( step_child_recovered ): Se activa para un hijastro que previamente causó un Error de Hijastro, pero que ya no presenta un error. Debería activarse después del evento "Paso Iniciado" y, posiblemente, después de un evento "Error de Hijastro".

Estructura del evento

Los eventos siguen la jerarquía flujo > grupo de pasos > hijastro. Los campos comunes a los eventos de flujo están presentes en los eventos de grupo de pasos y hijastro, mientras que los campos comunes a los eventos de grupo de pasos también están presentes en los eventos de hijastro.

Estructura de eventos de flujo

Todos los eventos de nivel de flujo tienen la siguiente estructura común:

• id : flow_started (cadena, obligatoria) - Identificador de caso Snake para el tipo de evento
• nombre : Flujo iniciado (cadena, obligatorio): nombre con formato humano del tipo de evento
• flowId : -JEz-zuieQH29FZLHqvR (cadena, obligatoria) - El ID del objeto de flujo
• flowName : Flujo de incorporación (cadena, obligatoria): título legible para humanos de este flujo
• flowVersion : 1465479478192 (número, obligatorio) - Indica una versión particular de un flujo (actualmente la misma que la marca de tiempo updatedAt )
• sessionId : 1478371724807 (número, obligatorio) - Identificador de una sesión particular de un usuario, que corresponde a una inicialización particular del script Appcues
• timestamp : 1478371725400 (número, obligatorio) - Marca de tiempo en la que se generó el evento

Error de flujo

Los eventos de error de flujo también incluirán los siguientes campos:

• error : No se pudo cargar CSS. (cadena, obligatoria) - Un resumen de texto del error
• detalles (cadena, obligatoria): una explicación más detallada del error, que generalmente hace referencia a los errores de los pasos secundarios que generaron este error a nivel de paso

Estructura de los eventos de paso

Todos los eventos de nivel de paso tienen las propiedades de nivel de flujo anteriores y comparten los siguientes campos:

• stepId: -JEz-zvIXWj-9qNICQYK (cadena, obligatoria) - El ID del objeto del grupo de pasos
• stepType : hotspot -group (cadena, obligatorio) - El tipo de patrón de este grupo de pasos ( hotspot -group, modal , etc.)

Paso interactuado

Los eventos interactuados por pasos también incluirán los siguientes campos:

• stepChildId : -JKafq_L5HRpGN3vIYB2 (cadena, obligatoria) - El ID del hijastro en el que el usuario realizó una interacción
• stepChildNumber : 1 (número, obligatorio): el índice (basado en cero) del hijastro en el que el usuario realizó una interacción
• interactionType : click (cadena, obligatorio) - Cómo interactuó el usuario con el grupo de pasos (clic, pasar el cursor, enviar, etc.)
• interacción (objeto, requerido) - Un objeto que representa información sobre la interacción del usuario
• interaction.category : link (cadena, opcional) - Categoría de la cosa sobre la que se realizó el interactionType

Valores de tipo de interacción y categoría existentes :

Dependiendo del valor de interaction.category , el objeto de interacción contiene diferentes campos:

Formulario enviado

Los eventos enviados por formulario incluirán los campos de los eventos interactuados por paso con las siguientes modificaciones:

• interactionType: submit (string, required) - Enviar siempre para eventos de formulario enviado
  • interacción (objeto, requerido) - Un objeto que representa información sobre la interacción del usuario
  • interation.category : form (cadena, obligatorio) - Siempre form para eventos de formulario enviado
  • interaction.formId : -JKgfc1rgO8JlCrh0B1U (cadena, obligatoria) - El ID del objeto de formulario que se envió
  • interaction.response (matriz, obligatorio): lista de objetos de respuesta
    • (objeto)
      • fieldId : -KQaXuLFQEcbyzuNftXr (cadena, obligatoria) - El ID de un campo específico en un formulario
        • etiqueta : Correo electrónico (cadena, obligatoria): la etiqueta que describe el campo del formulario
        • valor : test@example.com (obligatorio, acepta valores nulos): el valor que el usuario ingresó en el campo de formulario

Campo de formulario enviado

Los eventos enviados por campos de formulario incluirán los campos de los eventos interactuados por pasos con las siguientes modificaciones:

• interactionType : submit (string, required) - Enviar siempre para eventos de campo de formulario enviado
• interacción (objeto, requerido) - Un objeto que representa información sobre la interacción del usuario
  • interaction.category: form (string, required) - Siempre form para eventos de campo de formulario enviado
  • interaction.formId: -JKgfc1rgO8JlCrh0B1U (cadena, obligatoria) - El ID del objeto de formulario desde el que se envió este campo
  • interaction.fieldId : -KQaXuLFQEcbyzuNftXr (cadena, obligatoria) - El ID de este campo de formulario
  • interaction.label : Correo electrónico (cadena, obligatorio) - La etiqueta que describe este campo de formulario
  • interaction.value: test@example.com (obligatorio, acepta valores nulos) - El valor que el usuario ingresó en este campo de formulario

Error de paso

Los eventos de error de paso incluirán todos los campos de nivel de paso además de los siguientes:

• error : No se pudo cargar CSS. (cadena, obligatoria) - Un resumen de texto del error
• detalles (cadena, obligatoria): una explicación más detallada del error, que generalmente hace referencia a los errores de los pasos secundarios que generaron este error a nivel de paso

Estructura de los eventos de hijastros

Todos los eventos de hijastro incluirán los campos de eventos de hijastro además de lo siguiente:

• stepChildId : -JKafq_L5HRpGN3vIYB2 (cadena, obligatoria) - El ID del hijastro
• stepChildNumber : 1 (número, obligatorio) - El índice (basado en cero) del hijastro

Hijastro Desactivado

Los eventos de hijastro desactivado también incluirán los siguientes campos:

• timeSpent : 12537 (número, obligatorio) - La cantidad de tiempo en ms dedicado al hijastro

Error del hijastro

Los eventos de error de hijastro también incluirán los siguientes campos:

• error (cadena, obligatoria) - La descripción del error