Analytics
Endpoints de análise e Business Intelligence. Fornecem dados agregados sobre chamadas, atendentes e tendências. Requer papel de manager ou superior.
Endpoints
| Método | Endpoint | Descrição | Role Mínimo |
|---|---|---|---|
GET | /api/v1/analytics/overview | Visão geral (KPIs) | manager |
GET | /api/v1/analytics/hourly | Distribuição por hora | manager |
GET | /api/v1/analytics/agents | Performance dos atendentes | manager |
GET | /api/v1/analytics/trends | Tendências temporais | manager |
POST | /api/v1/analytics/refresh-views | Atualizar views materializadas | manager |
Visão Geral
Retorna os KPIs (Key Performance Indicators) do período.
GET /api/v1/analytics/overviewQuery Parameters
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
date_from | string | 30 dias atrás | Data início (ISO 8601) |
date_to | string | hoje | Data fim (ISO 8601) |
department_id | uuid | - | Filtro por departamento |
Exemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/analytics/overview?date_from=2026-02-01&date_to=2026-02-18" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Resposta de Sucesso (200)
json
{
"data": {
"total_calls": 342,
"completed_calls": 298,
"missed_calls": 28,
"cancelled_calls": 16,
"avg_duration": 285,
"avg_wait_time": 18,
"avg_rating": 4.6,
"total_customers": 215,
"new_customers": 48,
"completion_rate": 87.1,
"satisfaction_rate": 92.0
}
}Distribuição por Hora
Retorna a distribuição de chamadas por hora do dia.
GET /api/v1/analytics/hourlyQuery Parameters
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
date_from | string | 7 dias atrás | Data início |
date_to | string | hoje | Data fim |
department_id | uuid | - | Filtro por departamento |
Exemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/analytics/hourly?date_from=2026-02-11&date_to=2026-02-18" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Resposta de Sucesso (200)
json
{
"data": [
{ "hour": 8, "total": 12, "completed": 10, "missed": 2 },
{ "hour": 9, "total": 25, "completed": 23, "missed": 2 },
{ "hour": 10, "total": 38, "completed": 35, "missed": 3 },
{ "hour": 11, "total": 42, "completed": 40, "missed": 2 },
{ "hour": 12, "total": 15, "completed": 13, "missed": 2 },
{ "hour": 13, "total": 20, "completed": 18, "missed": 2 },
{ "hour": 14, "total": 45, "completed": 42, "missed": 3 },
{ "hour": 15, "total": 40, "completed": 37, "missed": 3 },
{ "hour": 16, "total": 35, "completed": 33, "missed": 2 },
{ "hour": 17, "total": 22, "completed": 20, "missed": 2 }
]
}Performance dos Atendentes
Retorna métricas de performance por atendente.
GET /api/v1/analytics/agentsQuery Parameters
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
date_from | string | 30 dias atrás | Data início |
date_to | string | hoje | Data fim |
department_id | uuid | - | Filtro por departamento |
sort_by | string | total_calls | Ordenação: total_calls, avg_duration, avg_rating |
sort_order | string | desc | Direção |
Exemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/analytics/agents?date_from=2026-02-01" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Resposta de Sucesso (200)
json
{
"data": [
{
"user_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"user_name": "João Silva",
"total_calls": 85,
"completed_calls": 78,
"missed_calls": 5,
"avg_duration": 312,
"avg_wait_time": 15,
"avg_rating": 4.8,
"total_duration": 24336,
"satisfaction_rate": 95.0
},
{
"user_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"user_name": "Maria Santos",
"total_calls": 72,
"completed_calls": 68,
"missed_calls": 3,
"avg_duration": 278,
"avg_wait_time": 12,
"avg_rating": 4.7,
"total_duration": 18904,
"satisfaction_rate": 93.0
}
]
}Tendências
Retorna dados agregados ao longo do tempo para visualização de tendências.
GET /api/v1/analytics/trendsQuery Parameters
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
date_from | string | 30 dias atrás | Data início |
date_to | string | hoje | Data fim |
granularity | string | day | Granularidade: day, week, month |
department_id | uuid | - | Filtro por departamento |
Exemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/analytics/trends?date_from=2026-02-01&granularity=day" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Resposta de Sucesso (200)
json
{
"data": [
{
"date": "2026-02-01",
"total_calls": 18,
"completed_calls": 16,
"avg_duration": 290,
"avg_rating": 4.5,
"new_customers": 3
},
{
"date": "2026-02-02",
"total_calls": 22,
"completed_calls": 20,
"avg_duration": 310,
"avg_rating": 4.7,
"new_customers": 5
}
]
}Atualizar Views Materializadas
Força a atualização das views materializadas de analytics. Útil quando dados recentes não aparecem nas consultas.
POST /api/v1/analytics/refresh-viewsExemplo de Request
bash
curl -X POST https://voki.avanter.com.br/api/v1/analytics/refresh-views \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Resposta de Sucesso (200)
json
{
"data": {
"message": "Views materializadas atualizadas com sucesso",
"refreshed_at": "2026-02-18T17:30:00Z"
}
}