CZapyChat
GET/public/ratings/summary

Resumo das avaliações

Médias, distribuição das notas, taxa de resposta e ranking por atendente no período.

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ó deste atendente.
curl -X GET "https://api.zapychat.com.br/api/v1/public/ratings/summary" \
  -H "Authorization: Bearer pk_sua_chave"
Resposta · 200
{
  "data": {
    "responses": 42,
    "sent": 80,
    "responseRate": 53,
    "avgScore": 4.5,
    "avgAgentScore": 4.6,
    "distribution": {
      "1": 1,
      "2": 2,
      "3": 4,
      "4": 12,
      "5": 23
    },
    "byAgent": [
      {
        "agentId": "cmf1usr456",
        "agentName": "João Lima",
        "responses": 20,
        "avgScore": 4.7,
        "avgAgentScore": 4.8
      }
    ]
  },
  "meta": {
    "timestamp": "2026-10-05T14:32:10.000Z"
  }
}