Skip to content

Analytics

Endpoints d'analyse et de Business Intelligence. Fournissent des données agrégées sur les appels, les agents et les tendances. Nécessite le rôle manager ou supérieur.

Endpoints

MéthodeEndpointDescriptionRôle Minimum
GET/api/v1/analytics/overviewVue d'ensemble (KPIs)manager
GET/api/v1/analytics/hourlyDistribution par heuremanager
GET/api/v1/analytics/agentsPerformance des agentsmanager
GET/api/v1/analytics/trendsTendances temporellesmanager
POST/api/v1/analytics/refresh-viewsActualiser les vues matérialiséesmanager

Vue d'Ensemble

Retourne les KPIs (Key Performance Indicators) de la période.

GET /api/v1/analytics/overview

Query Parameters

ParamètreTypeDéfautDescription
date_fromstring30 jours avantDate de début (ISO 8601)
date_tostringaujourd'huiDate de fin (ISO 8601)
department_iduuid-Filtre par département

Exemple de Requête

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"

Réponse de Succès (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
  }
}

Distribution par Heure

Retourne la distribution des appels par heure de la journée.

GET /api/v1/analytics/hourly

Query Parameters

ParamètreTypeDéfautDescription
date_fromstring7 jours avantDate de début
date_tostringaujourd'huiDate de fin
department_iduuid-Filtre par département

Exemple de Requête

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"

Réponse de Succès (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 des Agents

Retourne les métriques de performance par agent.

GET /api/v1/analytics/agents

Query Parameters

ParamètreTypeDéfautDescription
date_fromstring30 jours avantDate de début
date_tostringaujourd'huiDate de fin
department_iduuid-Filtre par département
sort_bystringtotal_callsTri : total_calls, avg_duration, avg_rating
sort_orderstringdescDirection

Exemple de Requête

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"

Réponse de Succès (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
    }
  ]
}

Tendances

Retourne des données agrégées dans le temps pour la visualisation des tendances.

GET /api/v1/analytics/trends

Query Parameters

ParamètreTypeDéfautDescription
date_fromstring30 jours avantDate de début
date_tostringaujourd'huiDate de fin
granularitystringdayGranularité : day, week, month
department_iduuid-Filtre par département

Exemple de Requête

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"

Réponse de Succès (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
    }
  ]
}

Actualiser les Vues Matérialisées

Force l'actualisation des vues matérialisées d'analytics. Utile lorsque les données récentes n'apparaissent pas dans les requêtes.

POST /api/v1/analytics/refresh-views

Exemple de Requête

bash
curl -X POST https://voki.avanter.com.br/api/v1/analytics/refresh-views \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Réponse de Succès (200)

json
{
  "data": {
    "message": "Vues matérialisées actualisées avec succès",
    "refreshed_at": "2026-02-18T17:30:00Z"
  }
}

Documentação da API Voki v4.0