Saltar al contenido principal
GET
/
api
/
instance
/
metrics
/
:instance
Leer métricas
curl --request GET \
  --url https://api.example.com/api/instance/metrics/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

​
Descripción

Devuelve contadores de mensajes (total, por tipo, por status, últimos 7/30 días, contactos únicos, etc.) para una instancia o un conjunto consolidado de varias a la vez.

​
Cómo funciona

El parámetro :instance acepta dos formatos:
  • Una sola instancia: /metrics/sales devuelve sus métricas
  • Múltiples instancias: /metrics/sales,support,marketing devuelve un único objeto con los valores sumados entre ellas
Cuando pasas varias, los valores numéricos se suman, los timestamps devuelven el menor/mayor (primer mensaje / último mensaje), y el campo instance de la respuesta trae la lista original.

​
Ejemplos

​
Una instancia

Pasando un único nombre en el path devuelve las métricas de esa instancia de forma aislada, ideal para dashboards individuales o para leer estadísticas de un número específico. 
curl -X GET "https://ryzeapi.cloud/api/instance/metrics/sales" \
  -H "token: $Token_Instance"

​
Múltiples (consolidado)

Pasando varios nombres separados por coma devuelve un único objeto con valores numéricos sumados entre las instancias. Útil para vistas agregadas por departamento o cuenta. 
curl -X GET "https://ryzeapi.cloud/api/instance/metrics/sales,support,marketing" \
  -H "token: $Token_Account"

​
Parámetros de ruta

​
instance
string
requerido
Un único nombre (p. ej., sales) o lista separada por coma (p. ej., sales,support). Espacios alrededor de las comas son aceptados.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Respuesta exitosa

200 OK
{
  "success": true,
  "message": "Metrics retrieved successfully",
  "metrics": {
    "instance": "sales",
    "totalMessages": 1523,
    "messagesReceived": 981,
    "messagesSent": 542,
    "messagesByType": {
      "text": 1205,
      "image": 187,
      "audio": 72,
      "video": 34,
      "document": 15,
      "sticker": 10
    },
    "groupMessages": 384,
    "individualMessages": 1139,
    "messagesWithMedia": 318,
    "mediaByType": {
      "image": 187,
      "audio": 72,
      "video": 34,
      "document": 15,
      "sticker": 10
    },
    "messagesByStatus": {
      "sent": 542,
      "received": 981,
      "delivered": 320,
      "read": 210,
      "pending": 12
    },
    "uniqueChats": 97,
    "uniqueGroups": 14,
    "uniqueContacts": 83,
    "messagesLast7Days": 412,
    "messagesLast30Days": 1287,
    "firstMessageAt": "2026-02-01T15:32:10Z",
    "lastMessageAt": "2026-04-18T23:14:55Z"
  }
}

​
Campos de respuesta

CampoQué es
totalMessagesTotal de mensajes enviados + recibidos
messagesReceived / messagesSentDesglose por dirección
messagesByTypeConteo por tipo (text, image, audio, video, document, sticker, etc.)
groupMessages / individualMessagesDesglose grupo vs 1-a-1
messagesWithMediaCuántos tenían media adjunta
mediaByTypeConteo de media por tipo
messagesByStatusDesglose por status (pending, sent, delivered, read, played, failed)
uniqueChats / uniqueGroups / uniqueContactsConteos únicos
messagesLast7Days / messagesLast30DaysRecencia
firstMessageAt / lastMessageAtFechas extremas

​
Errores

HTTPCondición
400Path vacío o solo comas
401Token faltante o inválido
404Cualquier instancia de la lista no existe
429Más de 100 solicitudes por minuto

​
Notas

Si la instancia tiene ignoreGroupMessages activo, los mensajes de grupo no se cuentan, groupMessages puede aparecer como 0.
Para dashboards de alta frecuencia, considera almacenar los valores de tu lado, cada llamada realiza cómputos completos y puede tardar en instancias de alto volumen.

​
Siguiente

Listar instancias

Estado actual de conexión y resumen de integraciones.

Actualizar settings

Ajusta flags de comportamiento como ignoreGroupMessages.