Relatórios
Acesse métricas de atendimento, CSAT e desempenho de agentes e equipes via API.
GET
Resumo dos Relatórios
Retorna as principais métricas de atendimento do período.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports/summary
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Query Parameters
since
string
obrigatório
Data de início (Unix timestamp). Ex:
1714521600
until
string
obrigatório
Data de fim (Unix timestamp).
type
string
Tipo:
account, agent, inbox, team. Padrão: account.
id
integer
ID do agente/inbox/equipe quando
type não for account.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports/summary?since=1714521600&until=1717113600 \
--header 'api_access_token: '
200
{
"avg_first_response_time": "00:04:32",
"avg_resolution_time": "01:22:10",
"conversations_count": 248,
"resolutions_count": 201,
"incoming_messages_count": 1432,
"outgoing_messages_count": 1180,
"account_id": 1
}
GET
Relatório Detalhado
Retorna métricas detalhadas por dia para um período.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Query Parameters
metric
string
obrigatório
Métrica:
account_conversations, resolutions_count, avg_first_response_time, avg_resolution_time.
type
string
obrigatório
Tipo:
account, agent, inbox, team.
since
string
obrigatório
Data de início (Unix timestamp).
until
string
obrigatório
Data de fim (Unix timestamp).
id
integer
ID do agente/inbox/equipe.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports?metric=account_conversations&type=account&since=1714521600&until=1717113600 \
--header 'api_access_token: '
200
[
{"value": 12, "timestamp": 1714521600},
{"value": 18, "timestamp": 1714608000},
{"value": 9, "timestamp": 1714694400}
]
GET
Conversas por Agente
Retorna o volume de conversas segmentado por agente no período.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports/agents/conversations
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Query Parameters
since
string
obrigatório
Data de início (Unix timestamp).
until
string
obrigatório
Data de fim (Unix timestamp).
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/reports/agents/conversations?since=1714521600&until=1717113600 \
--header 'api_access_token: '
200
[
{"id": 1, "name": "João Silva", "conversations": 87},
{"id": 2, "name": "Maria Santos", "conversations": 103}
]