Ricky logorickyDocs

Consultar el reporte de envíos masivos

GET
/reports/broadcasts

Los envíos masivos de WhatsApp creados en el período y lo que pasó con sus destinatarios. Los días y las horas son de America/Panama, como en las páginas de Reportes; cada número se compara con el período anterior de la misma duración.

Permiso: reports:read.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de consulta

from?string

Primer día, YYYY-MM-DD, America/Panama, incluido. Envíalo junto con to; sin ninguno de los dos, el reporte cubre los últimos 7 días, hoy incluido.

Patrón^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatodate
to?string

Último día, YYYY-MM-DD, America/Panama, incluido. Un día posterior a hoy cuenta como hoy. El período tiene como máximo 366 días.

Patrón^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatodate

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Los envíos masivos de WhatsApp creados en el período y lo que pasó con sus destinatarios. Entregados y leídos salen del mensaje de plantilla que recibió la conversación de cada destinatario mientras corría el envío; un destinatario cuenta una vez.

curl -X GET 'https://getricky.ai/api/v1/reports/broadcasts'
{  "data": {    "period": {      "from": "2026-10-14",      "to": "2026-10-14",      "days": 1,      "granularity": "day",      "time_zone": "America/Panama",      "previous_from": "2026-10-14",      "previous_to": "2026-10-14"    },    "totals": {      "broadcasts": 0,      "recipients": 0,      "sent": 0,      "failed": 0,      "delivered": 0,      "read": 0    },    "previous": {      "broadcasts": 0,      "recipients": 0    },    "series": [      {        "slot": "2026-10-14",        "broadcasts": 0,        "recipients": 0      }    ],    "broadcasts": [      {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "template_name": "string",        "status": "queued",        "channel_name": "string",        "created_by_name": "string",        "created_at": "2026-10-14T15:30:00.000Z",        "completed_at": "2026-10-14T15:30:00.000Z",        "pending": 0,        "recipients": 0,        "sent": 0,        "failed": 0,        "delivered": 0,        "read": 0      }    ],    "generated_at": "2026-10-14T15:30:00.000Z"  }}