Relatorios

Acesse metricas e relatorios de atendimento. A API de relatorios usa o prefixo/api/v2.

Visao Geral

Os relatorios podem ser filtrados por periodo, agente, equipe, inbox e canal. Os dados sao retornados em formato adequado para graficos e dashboards.

Parametros Obrigatorios

Todos os endpoints de relatorios exigem os parametros since e until (UNIX timestamp em segundos). Requisicoes sem esses parametros retornarao erro.

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

Metricas de conversas: tempo de resposta, resolucao, volume.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`type`(query)	`string`	Sim	Tipo de metrica: account, agent, inbox, team, label
`since`(query)	`string`	Sim	Data inicio (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

Relatorio geral com metricas de performance.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`metric`(query)	`string`	Sim	Metrica: 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
`since`(query)	`string`	Sim	Data inicio (UNIX timestamp em segundos)
`until`(query)	`string`	Sim	Data fim (UNIX timestamp em segundos)

bash

# Metricas do ultimo mes por agente
curl -s "https://chat.seudominio.com/api/v2/accounts/1/reports?metric=conversations_count&type=agent&since=1706745600&until=1709424000" \
  -H "api_access_token: YOUR_TOKEN" | jq .

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

Resumo consolidado de todas as metricas.

Parametros

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

200Resumo de metricas

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

Relatorio 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 .