Relatórios e monitoramento pela API

Rotas

Em todas, o período máximo é de 90 dias e as datas valem como dias civis no fuso da conta. A chave de fluxo vê só o próprio fluxo; flowId pode apenas estreitar, e um fluxo de fora dá 404.

Passo a passo: relatório de atendimento

1. Escolha o período e, se quiser, filtre por fila (queueId) ou atendente (agentId):

curl -s "https://http.pipebr.app/v1/reports/attendance?from=2026-10-01&to=2026-10-07&queueId=b3a1c9de-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $PIPE_CHAVE"

1. A resposta traz o período e o relatório. O conteúdo de report segue as seções da tela de relatórios (veja Relatórios de atendimento):

{
  "fuso": "America/Sao_Paulo",
  "de": "2026-10-01",
  "ate": "2026-10-07",
  "catalogos": { "...": "filas, atendentes e etiquetas usadas nos filtros" },
  "report": { "...": "números do período" }
}

Esforço e satisfação devolvem fuso, de, ate e relatorio. Todos aceitam from, to e flowId.

Histórico de tickets

GET /v1/reports/history lista os tickets encerrados do período, com paginação por page e perPage, e aceita os filtros queueId, agentId, labelId, ticket (número) e contact:

curl -s "https://http.pipebr.app/v1/reports/history?from=2026-10-01&to=2026-10-07&perPage=50" \
  -H "Authorization: Bearer $PIPE_CHAVE"

A resposta traz linhas, total, pagina e porPagina, além do período e dos catálogos.

Para CSV, peça Accept: text/csv (ou ?format=csv). O arquivo traz todo o resultado filtrado, com as mesmas colunas da exportação da tela, até 10000 linhas. Acima disso, a resposta é 413 export_too_large: reduza o período ou os filtros.

curl -s "https://http.pipebr.app/v1/reports/history?from=2026-10-01&to=2026-10-07" \
  -H "Authorization: Bearer $PIPE_CHAVE" -H "Accept: text/csv" -o historico.csv

Para filtrar tickets encerrados com mais detalhes (por etiqueta, número ou período), veja também GET /v1/conversations em Conversas e tickets.

Contadores do dia

GET /v1/monitoring/summary devolve a situação de hoje: o que está aguardando, em atendimento e encerrado, atendentes por status, filas e tickets abertos por hora. Aceita queueId, agentId e flowId.

{
  "fuso": "America/Sao_Paulo",
  "janela": { "...": "início e fim do dia" },
  "agora": "2026-10-12T14:30:00.000Z",
  "realtime": { "...": "aguardando e em atendimento neste momento" },
  "agents": { "...": "atendentes por status" },
  "hoje": { "...": "totais do dia" },
  "queues": [],
  "ticketsOpenByHour": []
}

Veja como a equipe lê esses números em Monitorar atendimentos.