API de analíticas

Rastrea la interacción de los visitantes y recupera datos de analíticas incluyendo vistas de página, visitantes únicos, tiempo de lectura, distribución geográfica y estadísticas de dispositivos.

On this page

API de analíticas

La API de analíticas te permite rastrear las interacciones de los visitantes con tus publicaciones y recuperar métricas de interacción. Los datos de analíticas incluyen vistas de página, visitantes únicos, tiempo de lectura, mapas de calor a nivel de página, distribución geográfica y desgloses por dispositivo.

URL base: https://api.zenflip.io/v1/analytics

Rastrear un evento

Registra un evento de interacción del visitante. Este es un endpoint público utilizado por el visor de flipbooks incrustado --- no se requiere autenticación.

Límite de tasa: 30 eventos por segundo por dirección IP (para acomodar giros rápidos de página).

Cuerpo de la solicitud

Campo

Tipo

Requerido

Descripción

publicationId

string

Sí

UUID de la publicación siendo visualizada

eventType

string

Sí

Tipo de evento (máx. 30 caracteres): page_view, session_start, session_end, download, share

sessionId

string

No

Identificador de sesión del visitante (máx. 100 caracteres)

viewerId

string

No

Identificador anónimo del visitante (máx. 100 caracteres)

pageNumber

integer

No

Número de página visualizada

duration

integer

No

Tiempo dedicado a la página en segundos

deviceType

string

No

Categoría de dispositivo: desktop, tablet, mobile

browser

string

No

Nombre del navegador (ej., Chrome, Safari)

os

string

No

Sistema operativo (ej., macOS, Windows, iOS)

country

string

No

Código de país ISO 3166-1 alpha-2 (ej., US, GB)

city

string

No

Nombre de la ciudad (máx. 100 caracteres)

referrer

string

No

URL del referrer (máx. 500 caracteres)

metadata

object

No

Metadatos clave-valor arbitrarios

Ejemplo de solicitud

Ejemplo de respuesta

Resumen de la organización

Recupera un resumen de analíticas de alto nivel para todas las publicaciones de tu organización.

Parámetros de consulta

Parámetro

Tipo

Requerido

Descripción

start

string

No

Fecha de inicio en formato ISO 8601 (ej., 2026-01-01T00:00:00Z)

end

string

No

Fecha de fin en formato ISO 8601

range

string

No

Rango abreviado: 7d, 30d, 90d (sobreescrito por start/end)

Ejemplo de solicitud

Ejemplo de respuesta

Analíticas de publicación

Recupera analíticas detalladas para una publicación específica, incluyendo datos de mapa de calor a nivel de página, distribución geográfica y desglose por dispositivo.

Parámetros de consulta

Parámetro

Tipo

Requerido

Descripción

start

string

No

Fecha de inicio (ISO 8601)

end

string

No

Fecha de fin (ISO 8601)

Ejemplo de solicitud

Ejemplo de respuesta

Campos de la respuesta

Campo

Descripción

summary

Métricas agregadas para el rango de fechas

pageHeatmap

Conteos de vistas por página y tiempo medio dedicado

geography

Distribución de visitantes por país (códigos ISO alpha-2)

devices

Desglose por tipo de dispositivo (escritorio, móvil, tableta)

browsers

Desglose por nombre de navegador

viewsByDay

Serie temporal diaria de vistas y visitantes únicos

Exportar analíticas como CSV

Exporta datos de analíticas en bruto como un archivo CSV para usar en hojas de cálculo o herramientas de inteligencia de negocio.

Plan requerido: Creator o superior.

Parámetros de consulta

Parámetro

Tipo

Requerido

Descripción

pubId

string

No

Filtrar por ID de publicación

start

string

No

Fecha de inicio (ISO 8601)

end

string

No

Fecha de fin (ISO 8601)

Ejemplo de solicitud

Ejemplo de respuesta

La cadena CSV se devuelve en el campo data. Parsea la en el lado del cliente o guárdala directamente en un archivo.

Referencia de tipos de evento

Tipo de evento

Descripción

session_start

El visitante abrió la publicación

page_view

El visitante navegó a una página específica

session_end

El visitante cerró la publicación o navegó fuera

download

El visitante descargó el PDF (si está habilitado)

share

El visitante usó la funcionalidad de compartir

← Previous
API de publicaciones
Next →
API de captura de leads