Módulo report

Este modulo agrupa servicios de reportes. Útiles para saber el estado de avance de envío de una campaña o las estadísticas de una campaña.

1.Seguimiento en tiempo real

Servicio:

/report/livetrack

Informa el progreso de envío de una campaña

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero
ExplicaciónID de campaña
EjemploCampaignID=2
ParámetroStatisticsID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de envío, Si este atributo no esta presente se tomara el ultimo envío realizado. (Compatibilidad con versión anterior)
EjemploStatisticsID=4

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido
errorMsg_campaignNotFound
No se encuentra la campaña

Estructura de Salida:

campaign.schedule.ScheduleStatus
Estado del envio. Posibles valores [Pending|Preparing|Sending|Paused|Halted|Completed]
report.detailsOfSend.TotalSent
Total de emails enviados
report.detailsOfSend.TotalDelivered
Total de emails enviados menos los rebotes blandos y duros
report.detailsOfSend.TotalRecipients
Total de contactos a los que se le debe enviar un correo

** Solo se documentan los campos mas relevantes.

2.Reporte general

Servicio:

/report/livetrack

Informa el detalle de una campaña con todos sus posibles envíos. (Los envíos múltiples de una campaña se mantienen por compatibilidad con un sistema anterior)

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero
ExplicaciónID de campaña
EjemploCampaignID=2
ParámetroStatisticsID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de envío, Si este atributo no esta presente se tomara el ultimo envío realizado. (Compatibilidad con versión anterior)
EjemploStatisticsID=4

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido
errorMsg_campaignNotFound
No se encuentra la campaña
errorMsg_track
Error indeterminado al tratar de obtener el reporte

Estructura de salida:

report.sendFilesDetail
Apunta a un servicio que retorna un fichero con el detalle de los emails enviados
report.detailsOfSend.TotalSent
Apunta a un servicio que retorna un fichero con el detalle de los emails enviados
report.detailsOfSend.TotalDelivered
Total de emails enviados menos los rebotes blandos y duros
report.detailsOfSend.TotalRecipients
Total de contactos a los que se le debe enviar un correo
report.list.item.*
Atributos particulares de cada envío. Por lo general solo debe haber 1 envío
report.campaign.Name
Nombre de la campaña
report.campaign.publicURL
URL para compartir los reportes de la campaña

** Solo se documentan los campos mas relevantes.

3.Reportes distribuidos en el tiempo

Servicio:

/report/trackintime

Informa las lecturas (únicas y totales) y click distribuidos en el tiempo. Se recomienda usar Flot (http://code.google.com/p/flot/) para graficar este reporte

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero
ExplicaciónID de campaña
EjemploCampaignID=2
ParámetroStatisticsID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de envío, Si este atributo no esta presente se tomara el ultimo envío realizado. (Compatibilidad con versión anterior)
EjemploStatisticsID=4

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido
errorMsg_campaignNotFound
No se encuentra la campaña

Estructura de salida:

report.chart.UniqueReads
Pares [tick, valor] de lecturas únicas
report.chart.Reads
Pares [tick, valor] de lecturas únicas
report.chart.LinksClicks
Pares [tick, valor] de clicks en enlaces
report.chart.Ticks
Pares [tick, etiqueta]
report.campaign.CampaignID
ID de campaña
report.campaign.StatisticsID
ID de envío

** Solo se documentan los campos mas relevantes.

4.Reporte resumido

Servicio:

/report/trackgraph

Informe resumido de lecturas, rebotes, de-suscripciones, entregas de emails, etc. Se recomienda usar Flot (http://code.google.com/p/flot/) para graficar este reporte

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero
ExplicaciónID de campaña
EjemploCampaignID=2
ParámetroStatisticsID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de envío, Si este atributo no esta presente se tomara el ultimo envío realizado. (Compatibilidad con versión anterior)
EjemploStatisticsID=4

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido
errorMsg_trackGraph
Error indeterminado al tratar de obtener el reporte

Estructura de salida:

trackGraph.graph.Opened
Total de aperturas
trackGraph.graph.UniqueOpened
Total de aperturas únicas
trackGraph.graph.Clicks
Total de Clicks
trackGraph.graph.Bounces
Total de rebotes
trackGraph.graph.Unsubscribed
Total de de-suscripciones
trackGraph.graph.TotalDelivered
Total de emails enviados
trackGraph.graph.TotalRecipients
Total de destinatarios
trackGraph.graph.StatisticsID
ID de envío

** Solo se documentan los campos mas relevantes.

5.Exportación de reportes de lectura y clicks

Servicio:

/report/exportreads | /report/exportlinks

Genera un fichero csv con la informacion de lecturas (/report/exportreads) y clicks (/report/exportlinks) de una campaña. Una ves generado el fichero CSV se debe llamar al servicio "/download/export?FileToken=" para descargarlo

Parámetros:

ParámetroCampaignID
RequeridoSI
TipoNúmero Entero
ExplicaciónID de campaña
EjemploCampaignID=2
ParámetroStatisticsID
RequeridoNO
TipoNúmero Entero
ExplicaciónID de envío, Si este atributo no esta presente se tomara el ultimo envío realizado. (Compatibilidad con versión anterior)
EjemploStatisticsID=4

Errores:

errorMsg_formValidations
Uno o varios de los parámetros de entrada son incorrecto, faltan o son requerido
errorMsg_campaignNotFound
No se encuentra la campaña
errorMsg_exportDirNotWritable
No se puede escribir el fichero a disco
errorMsg_reads
Error indeterminado

Estructura de salida:

report.campaign.Name
Nombre de campaña
report.campaign.CampaignID
ID de campaña
report.campaign.StatisticsID
ID de envio
report.totalCount
Total de registros prosados
report.FileName
Nombre del fichero generado (a usar con /download/export)

** Solo se documentan los campos mas relevantes.

Si te interesa tener acceso a mas reportes o tenes sugerencias sobre nuevos reportes, por favor comunicate con nosotros. https://administracion.donweb.com/clientes/index.php?modulo=soporte&archivo=asistente