Pular para o conteúdo principal
GET
/
api
/
instance
/
metrics
/
:instance
Verificar Métricas
curl --request GET \
  --url https://api.example.com/api/instance/metrics/:instance \
  --header 'token: <token>'
Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna contadores de mensagens (total, por tipo, por status, últimos 7/30 dias, contatos únicos, etc.) para uma instância ou um conjunto consolidado de várias ao mesmo tempo.

​
Como funciona

O parâmetro :instance aceita dois formatos:
  • Uma instância única: /metrics/vendas retorna as métricas dela
  • Múltiplas instâncias: /metrics/vendas,suporte,marketing retorna um único objeto com os valores somados entre elas
Quando você passa várias, os valores numéricos são somados, os timestamps retornam o menor/maior (primeira mensagem / última mensagem), e o campo instance da resposta traz a lista original.

​
Exemplos

​
Uma instância

Passando um único nome no path, retorna as métricas daquela instância isoladamente, ideal para dashboards individuais ou para ler estatísticas de um número específico. 
curl -X GET "https://ryzeapi.cloud/api/instance/metrics/vendas" \
  -H "token: $Token_Instance"

​
Múltiplas (consolidado)

Passando vários nomes separados por vírgula, retorna um único objeto com os valores numéricos somados entre as instâncias. Útil para visões agregadas de departamento ou conta. 
curl -X GET "https://ryzeapi.cloud/api/instance/metrics/vendas,suporte,marketing" \
  -H "token: $Token_Account"

​
Path parameters

​
instance
string
obrigatório
Nome único (ex.: vendas) ou lista separada por vírgula (ex.: vendas,suporte). Espaços ao redor das vírgulas são aceitos.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Metrics retrieved successfully",
  "metrics": {
    "instance": "vendas",
    "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 da resposta

CampoO que é
totalMessagesTotal de mensagens enviadas + recebidas
messagesReceived / messagesSentQuebra por direção
messagesByTypeContagem por tipo (text, image, audio, video, document, sticker, etc.)
groupMessages / individualMessagesQuebra entre grupo e 1-a-1
messagesWithMediaQuantas tinham mídia anexada
mediaByTypeContagem de mídias por tipo
messagesByStatusQuebra por status (pending, sent, delivered, read, played, failed)
uniqueChats / uniqueGroups / uniqueContactsContagens únicas
messagesLast7Days / messagesLast30DaysRecência
firstMessageAt / lastMessageAtDatas extremas

​
Erros

HTTPCondição
400Path vazio ou só com vírgulas
401Token ausente ou inválido
404Qualquer instância da lista não existe
429Mais de 100 requisições por minuto

​
Notas

Se a instância tiver ignoreGroupMessages ativo, mensagens de grupo não são contadas, groupMessages pode aparecer como 0.
Para dashboards de alta frequência, considere armazenar os valores no seu lado, cada chamada executa cálculos completos e pode demorar em instâncias com muito volume.

​
Próximo

Listar instâncias

Estado atual de conexão e resumo das integrações.

Atualizar settings

Ajuste flags de comportamento como ignoreGroupMessages.