Ricky logorickyDocs

Get the responses report

GET
/reports/responses

How fast people and AI agents answered customers in the period, per channel and responder. 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"
responder?|

Only responses from people, in Ricky or in the channel's own app (humans), from AI agents (agents), or from one member or AI agent by ID.

Default"all"

Response Body

Success.

application/json
  1. response
data*

How fast people and AI agents answer customers. A response is the first message sent to the customer, other than a reaction, right after a customer message that is not a reaction; its response time is the wait since that customer message. Later messages in a row are follow-ups, and automations and templates are not responses. Responses are dated when they were sent. Conversation openings, closes and assignments play no part.

curl -X GET 'https://getricky.ai/api/v1/reports/responses'
{  "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",    "responder": "all",    "awaiting_reply_now": 0,    "response_time": {      "responses": 0,      "average_seconds": 0,      "median_seconds": 0,      "p90_seconds": 0,      "previous_average_seconds": 0,      "buckets": [        {          "bucket": "under_30s",          "count": 0,          "share": 0        }      ],      "series": [        {          "slot": "2026-10-14",          "average_seconds": 0,          "median_seconds": 0,          "previous_average_seconds": 0,          "previous_median_seconds": 0        }      ]    },    "responses_per_conversation": {      "conversations": 0,      "average": 0,      "previous_average": 0,      "buckets": [        {          "bucket": "1_2",          "count": 0,          "share": 0        }      ],      "series": [        {          "slot": "2026-10-14",          "average": 0,          "previous_average": 0        }      ]    },    "by_channel": [      {        "channel": "whatsapp",        "responses": 0,        "conversations": 0,        "average_seconds": 0,        "median_seconds": 0,        "p90_seconds": 0      }    ],    "by_responder": [      {        "type": "human",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "channel": "whatsapp",        "responses": 0,        "conversations": 0,        "average_seconds": 0,        "median_seconds": 0,        "p90_seconds": 0      }    ],    "generated_at": "2026-10-14T15:30:00.000Z"  }}