Ricky logorickyDocs

Get the messages report

GET
/reports/messages

Messages received and sent in the period, and who sent them. 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
channel?string

Only this channel.

Default"all"
Value in"all""whatsapp""instagram""messenger"

Response Body

Success.

application/json
  1. response
data*

Messages received from customers and sent to them in the period, and who sent them, dated when each message was sent.

curl -X GET 'https://getricky.ai/api/v1/reports/messages'
{  "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"    },    "channel": "all",    "totals": {      "received": 0,      "sent": 0,      "sent_by": {        "human": 0,        "ai": 0,        "automation": 0,        "campaign": 0,        "external": 0      }    },    "previous": {      "received": 0,      "sent": 0,      "sent_by": {        "human": 0,        "ai": 0,        "automation": 0,        "campaign": 0,        "external": 0      }    },    "by_channel": [      {        "channel": "whatsapp",        "received": 0,        "sent": 0,        "sent_by": {          "human": 0,          "ai": 0,          "automation": 0,          "campaign": 0,          "external": 0        }      }    ],    "series": [      {        "slot": "2026-10-14",        "received": 0,        "sent": 0,        "sent_by": {          "human": 0,          "ai": 0,          "automation": 0,          "campaign": 0,          "external": 0        },        "previous_received": 0,        "previous_sent": 0      }    ],    "generated_at": "2026-10-14T15:30:00.000Z"  }}