Métricas

Números da operação da instância: mensagens, entrega, conversas, tempo até a primeira resposta, conversas sem resposta, origem por anúncio e saúde da conexão.

Basehttps://app.onzap.io/v1/instances/{instanceId}AuthX-Instance-Token: SEU_TOKEN

Métricas da instância

GET/v1/instances/{instanceId}/metrics

API OnZapAPI oficial

Mensagens recebidas e enviadas (via API e via celular), entrega, conversas, taxa de resposta, tempo até a primeira resposta (mediana e p90), origem por anúncio e saúde da conexão no período, com a série por dia ou por hora.

Calculadas só com metadados dos eventos (nunca o texto das mensagens), no fuso da conta (Configurações → Fuso horário). Grupos ficam de fora, a não ser com includeGroups=true.

Parâmetros de query

periodstringopcional

today, yesterday, last_7_days (padrão), last_30_days, this_month, last_month ou um texto em português ("ontem", "últimos 15 dias", "01/09 a 15/09").

fromstringopcional

Primeiro dia (AAAA-MM-DD, no fuso da conta). Tem prioridade sobre period.

tostringopcional

Último dia, inclusive (AAAA-MM-DD).

granularitystringopcional

day (padrão) ou hour (até 31 dias, só dentro dos últimos 34).

includeGroupsbooleanopcional

Incluir conversas em grupo (padrão false).

responseMinutesintegeropcional

Prazo de resposta, em minutos, da taxa de resposta e de "sem resposta" (padrão 60).

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/metrics" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Métricas do período

{
  "dataSince": "2026-09-30T14:05:00Z",
  "includeGroups": false,
  "instance": {
    "id": "3EB0C0A1B2C3D4E5F6",
    "name": "Maria Silva",
    "provider": "onzap",
    "status": "ok",
    "statusSince": "2026-09-30T14:05:00Z"
  },
  "notes": [
    "texto"
  ],
  "origin": [
    {
      "answeredWithin": 0,
      "conversations": 0,
      "headline": "texto",
      "responseRate": 0,
      "sourceId": "1234567890",
      "sourceType": "texto"
    }
  ],
  "period": {
    "from": "[email protected]",
    "granularity": "texto",
    "label": "texto",
    "timezone": "texto",
    "to": "[email protected]"
  },
  "responseMinutes": 0,
  "series": [
    {
      "answeredWithin": 0,
      "conversations": 0,
      "date": "texto",
      "delivered": 0,
      "failed": 0,
      "hour": "texto",
      "read": 0,
      "received": 0,
      "responseRate": 0,
      "sent": 0,
      "sentApi": 0,
      "sentPhone": 0,
      "unansweredWithin": 0
    }
  ],
  "totals": {
    "answeredWithin": 0,
    "availability": 0,
    "businessInitiated": 0,
    "conversations": 0,
    "delivered": 0,
    "downtimeSeconds": 0,
    "drops": 0,
    "failed": 0,
    "firstResponse": {
      "api": {
        "medianSeconds": 0,
        "p90Seconds": 0,
        "samples": 0
      },
      "medianSeconds": 0,
      "p90Seconds": 0,
      "phone": {
        "medianSeconds": 0,
        "p90Seconds": 0,
        "samples": 0
      },
      "samples": 0
    },
    "fromAds": 0,
    "pending": 0,
    "read": 0,
    "received": 0,
    "responseRate": 0,
    "sent": 0,
    "sentApi": 0,
    "sentPhone": 0,
    "stoppedSeconds": 0,
    "unansweredNow": 0,
    "unansweredWithin": 0
  }
}

Conversas sem resposta agora

GET/v1/instances/{instanceId}/metrics/unanswered

API OnZapAPI oficial

Conversas cuja última mensagem é do cliente, sem nenhuma enviada depois, esperando há mais de minutes. Das esperas mais longas para as mais curtas.

Parâmetros de query

minutesintegeropcional

Há quanto tempo, no mínimo, o cliente está esperando (padrão 60).

lookbackDaysintegeropcional

Até quantos dias atrás olhar (padrão 7, máximo 30).

limitintegeropcional

Quantidade (padrão 50, máximo 500).

includeGroupsbooleanopcional

Incluir grupos (padrão false).

Requisição

curl "https://app.onzap.io/v1/instances/SUA_INSTANCIA/metrics/unanswered" \
  -H "X-Instance-Token: $ONZAP_TOKEN"

Resposta

Conversas esperando resposta

{
  "items": [
    {
      "chatId": "[email protected]",
      "isGroup": false,
      "lastReceivedAt": "2026-09-30T14:05:00Z",
      "messages": 0,
      "name": "Maria Silva",
      "phone": "5511999999999",
      "waitingMinutes": 0,
      "waitingSince": "2026-09-30T14:05:00Z"
    }
  ],
  "lookbackDays": 0,
  "minutes": 0,
  "total": 0
}