Algebraix logo
Powered by Redocly

Estadísticas

Listar mensajes de difusión enviados

Devuelve la lista de mensajes de difusión (broadcast) enviados por operadores o administradores con el esquema v2 del outbox (varios destinatarios). Los mensajes enviados a un único destinatario, los del esquema legacy y los enviados por profesores/padres/usuarios se excluyen. Cada elemento incluye action_id, título, remitente y fecha de envío. Permite filtrar por remitente y por un rango de fechas de envío.

Request
query Parameters
limit
integer [ 1 .. 500 ]
Default: 100

Número máximo de mensajes a devolver (por defecto 100, máximo 500)

min_recipients
integer >= 10
Default: 10

Número mínimo de destinatarios que debe tener el mensaje para aparecer en la lista (por defecto 10, mínimo 10). Excluye los envíos pequeños (p. ej. un alumno y sus dos padres). El conteo suma destinatarios directos y miembros de listas.

sender_id
string (id) = 8 characters ^[A-Z0-9]{8}$

Filtrar por el ID del remitente

send_date_start
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha inicial del rango de envío (DD/MM/YYYY). Si se omite send_date_end se usa la fecha actual como límite superior. No puede ser una fecha futura.

Nota: El rango entre send_date_start y send_date_end no puede exceder 180 días.

send_date_end
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...

Fecha final del rango de envío (DD/MM/YYYY). Si se omite send_date_start, se usa send_date_end también como fecha inicial (búsqueda de un solo día). No puede ser una fecha futura.

Nota: El rango entre send_date_start y send_date_end no puede exceder 180 días.

header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

Lista de mensajes enviados

400

Parámetros inválidos

401

Authorization Required

get/messaging
Request samples 
Response samples 
application/json
[
  • {
    }
]
Obtener estadísticas de un mensaje enviado
Devuelve las estadísticas agregadas (pixel-tracking + read/sign/deleted) de
un mensaje de difusión enviado identificado por action_id. Sólo aplica a
mensajes v2 con 10 o más destinatarios; un mensaje legacy o con menos de
10 destinatarios se rechaza con 400.


Request 
path Parameters
action_id
required
string  = 8 characters 
ID de 8 caracteres de la acción de envío (broadcast) en _m_chains


 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
Estadísticas del mensaje enviado


400
Parámetros inválidos o mensaje no elegible


401
Authorization Required


403
Sin permisos para consultar las estadísticas de este envío


404
Mensaje no encontrado para el action_id solicitado


get/messaging/{action_id}/stats
Request samples 
Response samples 
application/json
{
  • "total_sent": 12,
  • "total_signed": 3,
  • "unique_reads": 8,
  • "total_families": 5,
  • "family_reads": 4,
  • "total_algebraix_platform": 6,
  • "total_email_platform": 4
}
➔ Next to Barra de progreso