/message/stats
Obtiene el resumen y estadísticas de una campaña o mensaje de automatización.
Parámetros |
Nombre |
Descripción |
message_id
integer |
ID numérico del mensaje. Puede ser mensaje de campaña o de automatización. |
nocache
boolean |
El sistema almacena los últimos datos de las estadísticas en memoria cache. Utilice este parámetro en TRUE para volver a calcular las estadísticas. Esto podría demorar un tiempo más en devolver el resultado. |
Valores de retorno |
status |
Devuelve el estado actual del mensaje. “completed”, “scheduled”, “stopped”, “saved”, “sending”, “restarting”. |
recipients |
Número de destinatarios total. |
from_name |
Nombre del remitente. |
from_mail |
Email del remitente. |
track_opens |
Opción para seguimiento de aperturas. 1 define activado. |
track_clicks |
Opción para seguimiento de clicks. 1 define activado. |
g_analytics |
Opción para integración con Google Analytics. 1 define activado. |
clicktale |
Opción para integración con ClickTale. 1 define activado. |
date_created |
Fecha de creación del mensaje en formato UNIX. |
date_start |
Fecha de inicio del envío del mensaje en formato UNIX. Solo para campañas. |
date_completed |
Fecha de envío completado en formato UNIX, solo para campañas. |
lists |
Array de listas de destinatarios.
name |
Nombre de la lista. |
list_id |
ID de la lista. |
|
stats |
Estadísticas del mensaje.
sent |
Array con la cantidad de emails enviados.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de suscriptores. |
|
not_sent |
Array con la cantidad de emails no enviados.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de suscriptores. |
|
delivered |
Array con la cantidad de emails entregados.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de suscriptores. |
|
pending |
Array con la cantidad de emails pendientes de envío.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de suscriptores. |
|
bounced |
Array con la cantidad de emails rechazados.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de emails enviados. |
type |
Array. Tipos de rechazo, “soft”, “hard”, “spam”, “invalid”. (Ver detalles debajo).
soft/hard/spam/invalid
Array |
value |
Valor numérico total |
per |
Porcentaje relativo a la cantidad de rechazados |
abs_per |
Porcentaje relativo a la cantidad de emails enviados |
|
|
|
unsubscribed |
Array con la cantidad de emails desuscriptos.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de emails entregados. |
|
opens |
Array con la cantidad de aperturas.
value |
Cantidad numérica de suscriptores que abrieron el email. |
per |
Porcentaje relativo a la cantidad de emails entregados. |
total |
Total de aperturas incluyendo repeticiones. |
ratio |
Diferencia entre aperturas totales y únicas (suscriptores). |
firstDayReads |
Dia de la primera apertura. Array. |
data |
Array con los datos de aperturas por días de la semana y horas del día. |
|
clicks |
Array con la cantidad de emails desuscriptos.
unique |
Clicks únicos. |
total |
Porcentaje relativo a la cantidad de emails entregados. |
subscribers |
Cantidad de suscriptores que hicieron click en uno o más enlaces |
data_list |
Array con la información de los links y clicks.
link |
URL del link html escaped. |
url |
URL del link. |
clicks |
Cantidad de suscriptores que hicieron click. |
clicks_totales |
Cantidad de clicks. |
id |
ID numérico del link. |
|
per |
Porcentaje de clicks/suscriptores relativo a la cantidad de emails entregados. |
|
referred |
Array con la cantidad de emails desuscriptos.
value |
Cantidad numérica de referidos. |
reads |
Array con la información de aperturas de los referidos.
value |
Cantidad numérica de aperturas. |
per |
Porcentaje de aperturas relativo a la cantidad de referidos. |
|
per |
Porcentaje de clicks/suscriptores relativo a la cantidad de emails entregados. |
|
complaints |
Array con la cantidad de emails suscriptores que han marcado el email como spam.
value |
Cantidad numérica. |
per |
Porcentaje relativo a la cantidad de emails entregados. |
|
device |
Array con la estadística de dispositivos utilizados para leer los emails. |
device_data |
Array con la estadística de dispositivos utilizados para leer los emails. |
ctr |
Porcentaje decimal Click-Through Rate (relativo a los emails entregados). |
ctor |
Porcentaje decimal Click-Through Open Rate (relativo a las aperturas). |
|
Códigos de error |
M05101D |
Mensaje no encontrado. |
Estados del mensaje de campaña
- completed: El mensaje ha sido enviado a toda la lista de suscriptores.
- scheduled: el mensaje esta programado para ser enviado en la fecha determinada por el usuario.
- stopped: el mensaje se ha detenido y no continua enviándose. Permite reanudar el envío.
- sending: el mensaje esta actualmente enviándose a la lista de suscriptores. La estadística de envía indicara la cantidad y porcentaje de enviados.
- restarting: el mensaje ha sido reiniciado y esta en espera de continuar su envío.
- starting: el mensaje esta iniciando su envío.
Estadística de rechazados
En la variable stats.bounced se detallan los emails rechazados. “type” define el tipo de rechazo, siendo “hard” y “soft” las categorías padre, donde “hard” son rechazados permanentes” y “soft” son rechazados temporales, como podría ser rechazado por casilla llena.
Los tipos “invalid” y “spam” son subcategorías de “hard” y “soft” respectivamente. “invalid” se refiere a los rechazados cuando la casilla de email no existe y “spam” se refiere a cuando el rechazo es a causa de que el email fue interpretado como SPAM. El sistema trata a los rechazados “spam” como temporales.