Producto
SDK

Estadísticas

Mensajes, costos por categoría y rendimiento de plantillas, con los datos de Meta

Introducción

El módulo Analytics trae las estadísticas que entrega Meta para un número: mensajes enviados, entregados y recibidos, gratis frente a pagados, costo por categoría y el rendimiento de cada plantilla. Son los mismos datos de Reportes > WhatsApp. Disponible desde la versión 2.4.0.

Inicialización

Plazbot (recomendado)·ts
01import { Plazbot } from 'plazbot';
02 
03const plazbot = new Plazbot({
04 workspaceId: "YOUR_WORKSPACE_ID",
05 apiKey: "YOUR_API_KEY",
06 zone: "LA"
07});
08 
09// Usar: plazbot.analytics.messages()

Mensajes y costos

ts
01const stats = await plazbot.analytics.messages({
02 from: "2026-10-01",
03 to: "2026-10-31",
04 number: "+51912345678" // opcional si el workspace tiene un solo número
05});
06 
07console.log(stats.totals.sent, stats.totals.cost);
08console.log(stats.byCategory.marketing); // { messages, cost }
CampoDescripción
totalsmessages, sent, delivered, received, free, paid y cost.
byCategorymarketing, utility, authentication y service, cada una con messages y cost.
freeGratis por ventana de servicio (customerServiceWindow) y por anuncio de 72 h (entryPoint), si Meta los entrega.
costEstimatedEl costo es estimado (cuentas que facturan a través de un BSP).
costNotAvailableMessagePor qué no hay costo, si no lo hay.

El costo está en la moneda de la cuenta de WhatsApp en Meta.


Rendimiento de plantillas

ts
01const report = await plazbot.analytics.templates({ from: "2026-10-01", to: "2026-10-31" });
02 
03if (report.analyticsUnavailable) {
04 await plazbot.analytics.enableTemplateInsights(); // Meta empieza a contar desde ahora
05} else {
06 for (const t of report.templates) console.log(t.name, t.sent, t.read, t.clicks, t.spent);
07}

Cada fila trae sent, delivered, read, clicks, los clics por botón (buttons) y el gasto (spent, null si Meta no entrega costos). Meta guarda 90 días: si pides más, startClamped viene en true.

¿Quieres probar la API en vivo? Abre el Playground.