Ricky logorickyDocs

Get the broadcasts report

GET
/reports/broadcasts

WhatsApp broadcasts created in the period and their recipients' outcomes. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.

Scope: reports:read.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Query Parameters

from?string

First day, YYYY-MM-DD, America/Panama, inclusive. Send it with to; without both, the report covers the last 7 days including today.

Match^(?:(?:\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])))$
Formatdate
to?string

Last day, YYYY-MM-DD, America/Panama, inclusive. A day after today counts as today. The period is at most 366 days.

Match^(?:(?:\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])))$
Formatdate

Response Body

Success.

application/json
  1. response
data*

WhatsApp broadcasts created in the period and what happened to their recipients. Delivered and read come from the template message each recipient's conversation got while the broadcast ran; a recipient counts once.

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"  }}