Ir al contenido
Todas las páginas de la documentación

Referencia

Referencia del SDK

Lo que carga el rastreador, lo que registra y cada ajuste que puede cambiar desde la página.

Lo que se carga en una página

Archivos del rastreador
ArchivoComprimidoSe carga
b.js5,1 KBEn todas las páginas.
r.js57,2 KBSolo cuando el plan del proyecto graba sesiones y la página no ha desactivado la reproducción.
s.js24,5 KBSolo en la carga de página que el recolector elige para una captura, cuando las capturas de página para mapas de calor están activadas en el proyecto.

b.js envía su primera página vista de inmediato y luego pide al colector los ajustes del proyecto. r.js y s.js solo se cargan cuando llegan esos ajustes y lo permiten. Si la solicitud falla, no se carga ninguno.

La solicitud de configuración también lleva la ruta de la página, el ancho de pantalla y una huella del diseño hecha con los nombres de las etiquetas, nunca con el texto. El recolector responde si todavía le falta una captura de esa página y se la encarga a un solo visitante cada vez, así que s.js solo se descarga en esa carga. Un diseño nuevo recibe una captura nueva, y un diseño que cambia en cada visita solo se captura a un ritmo limitado.

Atributos de la etiqueta script

Atributos de la etiqueta script
AtributoPredeterminadoQué hace
data-keyObligatorioLa clave de escritura de su proyecto.
data-hosthttps://in.webmetric.ioEl colector al que se envían los eventos. El panel de instalación incluye el suyo: https://in-stg.webmetric.io.
data-click="false"ActivadoDeja de registrar clics.
data-click-labels="false"ActivadoEnvía los clics sin la etiqueta del botón o enlace. Su posición y el tipo de control se siguen registrando.
data-scroll="false"ActivadoDeja de registrar la profundidad de desplazamiento.
data-replaySigue al proyectofalse desactiva la reproducción de sesiones en esta página. consent carga la grabadora solo después de consent(true).
data-snapshots="false"Sigue al proyectoDesactiva las capturas de página para mapas de calor en esta página.
data-mask=".a, #b"NingunoMás selectores CSS, separados por comas, cuyo texto se oculta en reproducciones y capturas de página.
data-hash="true"DesactivadoCuenta los cambios de fragmento, como /#/pricing, como páginas vistas.
data-query="true"DesactivadoCuenta los cambios solo de parámetros, como ?tab=2, como páginas vistas. Los parámetros UTM cuentan siempre.
data-consent="required"DesactivadoNo registra ni envía nada hasta que se llama a consent(true).
data-debug="true"DesactivadoMuestra en la consola cada lote y cada motivo por el que el rastreador se detiene. Añadir ?wm_debug=1 a la dirección de una página hace lo mismo durante una carga.

Una página solo puede desactivar la reproducción y las capturas de página. Si funcionan o no lo decide el proyecto, nunca la página.

Opciones de init()

Opciones de init()
OpciónPredeterminadoEquivalente en la etiqueta script
keyObligatoriodata-key
hosthttps://in.webmetric.iodata-host
autoClicktruedata-click
clickLabelstruedata-click-labels
autoScrolltruedata-scroll
replaySigue al proyecto. false o "consent".data-replay
snapshotsSigue al proyecto. false las desactiva.data-snapshots
maskSelectorsNinguno. Una matriz de selectores.data-mask
hashfalsedata-hash
queryfalsedata-query
consentNinguno. "required" espera el consentimiento.data-consent
debugfalsedata-debug
assetOriginhttps://cdn.webmetric.io/v1El directorio desde el que se cargó b.js. De ahí se cargan r.js y s.js.

El paquete exporta init(options), track(name, props), consent(granted) y flush(). flush() envía de inmediato los eventos en cola en lugar de esperar al siguiente lote.

Páginas vistas y cambios de ruta

  • La primera página vista se registra en cuanto se inicia el rastreador.
  • Las aplicaciones de una sola página están cubiertas: history.pushState, history.replaceState y los botones de atrás y adelante registran cada uno una página vista para la nueva ruta.
  • Una página vista solo se registra cuando cambia la página. De forma predeterminada, eso significa la ruta más los parámetros UTM que haya. Active data-query para contar cada cambio de parámetros y data-hash para contar los cambios de fragmento. En cualquier caso, la dirección que se envía solo conserva la ruta y los parámetros UTM.
  • La referencia solo se envía con la primera página vista de cada carga de página, así que moverse dentro de su aplicación no se cuenta como una referencia.
  • La profundidad de desplazamiento es el punto más bajo alcanzado en cada página, en tramos del 10 %.
  • Los envíos de formularios se describen por la estructura del elemento (etiqueta HTML, id, clases y posición). Un clic en un botón, enlace, pestaña, elemento de menú, interruptor u opción lleva además el tipo de control y su etiqueta, para que los informes nombren lo que se pulsó. Una etiqueta nunca sale de un campo de formulario ni de un elemento enmascarado: consulta las etiquetas de clic.
  • Los eventos se envían por lotes: cada cinco segundos, al llegar a 50 eventos, y cuando el visitante sale de la página o la oculta.

Eventos personalizados

Envíe un evento cuando ocurra algo que una página vista no puede mostrar, como un registro completado.

Etiqueta scriptJavaScript
window.webmetric.track("signup_completed", { plan: "growth", seats: 3 });
npmTypeScript
import { track } from "@webmetric/sdk";

track("signup_completed", { plan: "growth", seats: 3 });
  • Al nombre se le quitan los espacios de los extremos y se pasa a minúsculas; después debe tener de 1 a 64 caracteres entre a y z, 0 y 9, guion bajo, punto, dos puntos y guion. Un nombre que siga sin cumplirlo se descarta, con un único aviso en la consola.
  • Las propiedades son opcionales. Se guardan hasta 10, con claves de hasta 40 caracteres. Los números y booleanos se convierten en cadenas, los valores se cortan a 200 caracteres y todo lo demás se omite.
  • No ponga nunca datos personales, como una dirección de correo o un nombre, en el nombre de un evento ni en una propiedad.
  • Un evento personalizado nunca cuenta como página vista. Cuenta como un evento en su plan.

Los eventos personalizados aparecen en la página Eventos y se pueden exportar en CSV. Los pasos de un embudo corresponden a páginas vistas, clics y envíos de formularios.

Llamar a track() antes de que cargue el script

La etiqueta script se carga con defer, así que window.webmetric no existe hasta que se ha ejecutado. Para llamarlo antes, por ejemplo desde código en línea, añada este sustituto antes de la etiqueta script. Las llamadas hechas a través de él se envían cuando se inicia el rastreador.

Antes de la etiqueta scriptHTML
<script>
  window.webmetric = window.webmetric || {
    q: [],
    track: function () { this.q.push(arguments); },
    consent: function (granted) { this.c = granted; },
  };
</script>

Con el paquete npm, las llamadas a track() anteriores a init() se guardan, hasta 50, y se envían en cuanto se ejecuta.

Privacidad predeterminada

  • No se guarda nada en el dispositivo del visitante: ni cookies ni almacenamiento del navegador.
  • Un navegador que envía Do Not Track o Global Privacy Control no envía nada.
  • La reproducción oculta cada campo de formulario en el navegador, antes de enviar nada. Las capturas de página ocultan además todo el texto de la página.
  • Una etiqueta de clic es el nombre visible de un botón o enlace, nunca el texto de un campo de formulario ni de un elemento enmascarado, sin direcciones de correo ni números largos.
  • Las direcciones de página se envían sin la parte que sigue a un # ni ningún parámetro de consulta salvo utm_*, y las referencias como origen y ruta.
  • La clave de escritura es pública por diseño. Va en el código fuente de sus páginas y solo sirve para escribir, solo en su propio proyecto.

Los detalles están en privacidad y recogida de datos.