Relatórios

Acesse métricas e relatórios de atendimento. A API de relatórios usa o prefixo/api/v2.

Visão Geral

Os relatórios podem ser filtrados por período, agente, equipe, inbox e canal. Os dados são retornados em formato adequado para gráficos e dashboards.

Parâmetros recomendados

Os endpoints de relatórios usam o parâmetro type como agrupamento — sem ele, vários endpoints retornam 422 Unprocessable Entity. Sempre informe também since e until (UNIX timestamp em segundos) para delimitar o período; caso contrário um intervalo padrão é aplicado.

GET/api/v2/accounts/{account_id}/reports/conversations

Métricas de conversas: tempo de resposta, resolução, volume.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`type`(query)	`string`	Sim	Tipo de métrica: account, agent, inbox, team, label
`since`(query)	`string`	Sim	Data início (UNIX timestamp em segundos)
`until`(query)	`string`	Sim	Data fim (UNIX timestamp em segundos)
`id`(query)	`string`	Nao	ID do filtro (agent_id, inbox_id, etc)

bash

curl -s "https://chat.seudominio.com/api/v2/accounts/1/reports/conversations?type=account&since=1706745600&until=1709424000" \
  -H "api_access_token: YOUR_TOKEN" | jq .

GET/api/v2/accounts/{account_id}/reports

Relatório geral com métricas de performance.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`metric`(query)	`string`	Sim	Métrica: conversations_count, incoming_messages_count, outgoing_messages_count, avg_first_response_time, avg_resolution_time, resolutions_count
`type`(query)	`string`	Sim	Agrupamento: account, agent, inbox, team, label
`id`(query)	`integer`	Nao	ID da entidade. Obrigatório quando type != account (ex.: type=agent exige id do agente) — sem ele a API retorna 404.
`since`(query)	`integer`	Sim	Data início (UNIX timestamp em segundos)
`until`(query)	`integer`	Sim	Data fim (UNIX timestamp em segundos)

bash

# Metricas do ultimo mes no nivel da conta (type=account dispensa id)
curl -s "https://chat.seudominio.com/api/v2/accounts/1/reports?metric=conversations_count&type=account&since=1706745600&until=1709424000" \
  -H "api_access_token: YOUR_TOKEN" | jq .

# Por agente: type=agent EXIGE id do agente (sem id retorna 404)
curl -s "https://chat.seudominio.com/api/v2/accounts/1/reports?metric=conversations_count&type=agent&id=5&since=1706745600&until=1709424000" \
  -H "api_access_token: YOUR_TOKEN" | jq .

GET/api/v2/accounts/{account_id}/reports/summary

Resumo consolidado de todas as métricas.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`type`(query)	`string`	Sim	Agrupamento: account, agent, inbox, team
`since`(query)	`string`	Sim	Data início (UNIX timestamp em segundos)
`until`(query)	`string`	Sim	Data fim (UNIX timestamp em segundos)

200Resumo de métricas

json

{
  "conversations_count": 150,
  "incoming_messages_count": 890,
  "outgoing_messages_count": 720,
  "avg_first_response_time": 45.2,
  "avg_resolution_time": 1234.5,
  "resolutions_count": 130
}

GET/api/v2/accounts/{account_id}/summary_reports/channel

Relatório de performance por canal de atendimento.

bash

curl -s "https://chat.seudominio.com/api/v2/accounts/1/summary_reports/channel" \
  -H "api_access_token: YOUR_TOKEN" | jq .