Ricky logorickyDocs

Consultar el reporte de conversaciones

GET
/reports/conversations

Los clientes que escribieron en el período, nuevos o recurrentes, por canal, día y hora. 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"

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

Cuántos clientes escriben, si son nuevos y cuándo. Solo cuentan los mensajes que envían los clientes: un cliente es una conversación con al menos uno de ellos en el período, y es nuevo cuando su primer mensaje de todos cae en el período. Los mensajes del equipo, de los agentes de IA o de campañas y las aperturas y cierres de conversaciones no cuentan.

curl -X GET 'https://getricky.ai/api/v1/reports/conversations'
{  "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": {      "customers": 0,      "new_customers": 0,      "returning_customers": 0,      "messages": 0    },    "previous": {      "customers": 0,      "new_customers": 0,      "returning_customers": 0,      "messages": 0    },    "by_channel": [      {        "channel": "whatsapp",        "customers": 0,        "new_customers": 0,        "returning_customers": 0,        "messages": 0      }    ],    "series": [      {        "slot": "2026-10-14",        "new_customers": 0,        "returning_customers": 0,        "previous_customers": 0      }    ],    "heatmap": [      {        "day_of_week": 0,        "hour": 0,        "messages": 0      }    ],    "generated_at": "2026-10-14T15:30:00.000Z"  }}