CZapyChat
GET/public/ratings

Listar avaliações

Avaliações respondidas pelos clientes (nota do atendimento, nota do atendente e comentário), da mais recente para a mais antiga.

Chave com permissão de leitura (read)

Cabeçalhos

NomeTipoDescrição
AuthorizationobrigatóriostringBearer pk_sua_chave — a chave de API criada em Configurações › API Keys.

Parâmetros de consulta (query)

NomeTipoDescrição
fromstring (ISO 8601)Início do período. Padrão: 30 dias atrás.
tostring (ISO 8601)Fim do período. Padrão: agora. O período pode ter no máximo 1 ano.
agentIdstringSó avaliações deste atendente.
minScorenumberNota mínima do atendimento (1 a 5).
maxScorenumberNota máxima do atendimento (1 a 5).
pagenumberPágina (começa em 1). Padrão: 1.
limitnumberItens por página, de 1 a 100. Padrão: 25.

Observações

  • Notas de 1 a 5 estrelas: 1 = Ruim, 2 = Regular, 3 = Bom, 4 = Muito bom, 5 = Excelente.
curl -X GET "https://api.zapychat.com.br/api/v1/public/ratings?limit=10" \
  -H "Authorization: Bearer pk_sua_chave"
Resposta · 200
{
  "data": {
    "items": [
      {
        "id": "cmf5rat001",
        "score": 5,
        "agentScore": 4,
        "comment": "Atendimento rápido!",
        "source": "LINK",
        "respondedAt": "2026-10-05T15:00:00.000Z",
        "agentId": "cmf1usr456",
        "agentName": "João Lima",
        "conversationId": "cmf3k9x1a0001",
        "contactName": "Maria Souza"
      }
    ],
    "total": 1,
    "page": 1
  },
  "meta": {
    "timestamp": "2026-10-05T14:32:10.000Z"
  }
}