Ricky logorickyDocs

Consultar el reporte de respuestas

GET
/reports/responses

Qué tan rápido respondieron las personas y los agentes de IA a los clientes en el período, por canal y por quien respondió. 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
channel?string

Solo este canal.

Predeterminado"all"
Uno de"all""whatsapp""instagram""messenger"
responder?|

Solo las respuestas de personas, en Ricky o en la app del propio canal (humans), de agentes de IA (agents), o de un miembro o agente de IA por su ID.

Predeterminado"all"

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Qué tan rápido responden las personas y los agentes de IA a los clientes. Una respuesta es el primer mensaje enviado al cliente, que no sea una reacción, justo después de un mensaje del cliente que no sea una reacción; su tiempo de respuesta es la espera desde ese mensaje del cliente. Los mensajes siguientes seguidos son seguimientos, y las automatizaciones y las plantillas no son respuestas. Las respuestas se fechan cuando se enviaron. Las aperturas, los cierres y las asignaciones de conversaciones no cuentan.

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