Appearance
Métricas
As métricas consolidam a operação do Helpdesk em dois relatórios: o overview (saúde geral da fila) e o by-agent (produtividade por atendente). Ambos aceitam filtro de período sobre a data de criação dos tickets.
Headers obrigatórios
Todas as requisições devem incluir o header X-Helpdesk-Id (UUID) e Authorization: Bearer {token} com o token do agente (guard helpdeskAgent).
Filtros de Período
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
from | string | Não | Início do período, formato YYYY-MM-DD (sobre createdAt dos tickets). |
to | string | Não | Fim do período, formato YYYY-MM-DD. |
Sem filtros, os relatórios consideram todos os tickets da instância.
Endpoints
Visão Geral
Consolida volumes, SLA e tempos médios de toda a instância.
http
GET /v1/helpdesk/agent/metrics/overviewExemplo de Requisição
bash
curl -X GET "https://api.us.basis.tavares.in/v1/helpdesk/agent/metrics/overview?from=2026-09-01&to=2026-09-30" \
-H "X-Helpdesk-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"Respostas
200 OK
Retorna o consolidado do período.
json
{
"total": 142,
"byStatus": {
"open": 23,
"pending": 11,
"solved": 95,
"closed": 13
},
"firstResponseSlaBreached": 4,
"resolutionSlaBreached": 2,
"avgFirstResponseMinutes": 87.5,
"avgResolutionMinutes": 612.3,
"reopened": 6
}| Campo | Descrição |
|---|---|
total | Total de tickets no período. |
byStatus | Volume por status (open, pending, solved, closed). |
firstResponseSlaBreached | Tickets ativos (open/pending) sem primeira resposta e com firstResponseDueAt vencido. |
resolutionSlaBreached | Tickets ativos com resolutionDueAt vencido. |
avgFirstResponseMinutes | Tempo médio até a primeira resposta do agente, em minutos (null se não houver dados). |
avgResolutionMinutes | Tempo médio até a resolução, em minutos (null se não houver dados). |
reopened | Soma de reaberturas (reopenedCount) no período. |
Por Agente
Produtividade individual: tickets atribuídos, resolvidos e tempo médio de primeira resposta, ordenados pelos mais atribuídos.
http
GET /v1/helpdesk/agent/metrics/by-agentExemplo de Requisição
bash
curl -X GET "https://api.us.basis.tavares.in/v1/helpdesk/agent/metrics/by-agent?from=2026-09-01&to=2026-09-30" \
-H "X-Helpdesk-Id: 3fa85f64-5717-4562-b3fc-2c963f66afa6" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"Respostas
200 OK
Retorna um array com uma linha por agente (apenas agentes com tickets atribuídos no período).
json
[
{
"id": 1,
"name": "Maria Silva",
"assigned": 64,
"resolved": 51,
"avgFirstResponseMinutes": 72.4
},
{
"id": 2,
"name": "João Souza",
"assigned": 38,
"resolved": 30,
"avgFirstResponseMinutes": 105.9
}
]| Campo | Descrição |
|---|---|
id / name | Identificação do agente. |
assigned | Tickets atribuídos ao agente no período. |
resolved | Tickets com solvedAt preenchido. |
avgFirstResponseMinutes | Tempo médio de primeira resposta do agente, em minutos (null se não houver dados). |