Dashboard

Analytics dashboard data export

Retrieves dashboard leaderboard

get/dashboard/leaderboard

Returns per-agent performance metrics for a given playbook and time period. Includes contact metrics, task metrics, call metrics, WhatsApp metrics, agent status, and rankings.

Parámetros de consulta

  • playbook_idstringobligatorio
    ID of the playbook to filter by
    Ejemplo: 507f1f77bcf86cd799439011
  • periodstring
    Time period (e.g. this_week, this_month, last_week, last_month, last_two_months, last_7_days, last_14_days, last_30_days, custom)
    Ejemplo: this_week
  • start_datestring (date)
    Start date for custom period (ISO 8601)
    Ejemplo: 2024-01-01
  • end_datestring (date)
    End date for custom period (ISO 8601)
    Ejemplo: 2024-01-31

Respuestas

  • 200leaderboard data returned
  • 401unauthorized
  • 404playbook not found or playbook_id missing
  • 422date range exceeds limit
Petición
curl -X GET 'https://api.vixiees.com/api/v1/dashboard/leaderboard?playbook_id=507f1f77bcf86cd799439011' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "top_metrics": [
    {}
  ],
  "users": [
    {
      "user": {
        "id": "507f1f77bcf86cd799439011",
        "full_name": "Alice Smith",
        "email": "alice@example.com"
      },
      "contacted_count": 5,
      "won_count": 2,
      "conversion_rate": 40,
      "tasks_count": 10,
      "task_time": 600,
      "calls_count": 8,
      "calls_answered": 6,
      "call_time": 1800,
      "whatsapp_messages_sent": 3,
      "status": "available",
      "status_since": "2024-01-01T00:00:00Z",
      "last_task_completed_at": "2024-01-01T00:00:00Z",
      "last_call_ended_at": "2024-01-01T00:00:00Z",
      "contacted_rank": 1,
      "won_rank": 1,
      "conversion_rank": 1,
      "tasks_rank": 1
    }
  ],
  "averages": {},
  "status_summary": {}
}

Retrieves dashboard overview stats

get/dashboard/overview

Returns aggregated KPI metrics for a given playbook and time period. Each metric includes current value, previous period value, and the difference.

Parámetros de consulta

  • playbook_idstringobligatorio
    ID of the playbook to filter by
    Ejemplo: 507f1f77bcf86cd799439011
  • periodstring
    Time period (e.g. this_week, this_month, last_week, last_month, last_two_months, last_7_days, last_14_days, last_30_days, custom)
    Ejemplo: this_month
  • start_datestring (date)
    Start date for custom period (ISO 8601)
    Ejemplo: 2024-01-01
  • end_datestring (date)
    End date for custom period (ISO 8601)
    Ejemplo: 2024-01-31

Respuestas

  • 200overview stats returned
  • 401unauthorized
  • 404playbook not found or playbook_id missing
  • 422date range exceeds limit
Petición
curl -X GET 'https://api.vixiees.com/api/v1/dashboard/overview?playbook_id=507f1f77bcf86cd799439011' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "new_contacts": {
    "current": 10,
    "previous": 8,
    "difference": 2
  },
  "active_contacts": {
    "current": 10,
    "previous": 8,
    "difference": 2
  },
  "won_contacts": {
    "current": 10,
    "previous": 8,
    "difference": 2
  },
  "lost_contacts": {
    "current": 10,
    "previous": 8,
    "difference": 2
  },
  "stale_contacts": {
    "current": 10,
    "previous": 8,
    "difference": 2
  }
}

Retrieves dashboard tasks distribution

get/dashboard/pending_tasks

Returns task data for a given playbook, including summary cards, hourly distribution, and a breakdown by user and task type. Each breakdown entry includes both pending and completed counts.

Parámetros de consulta

  • playbook_idstringobligatorio
    ID of the playbook to filter by
    Ejemplo: 507f1f77bcf86cd799439011

Respuestas

  • 200tasks data returned
  • 401unauthorized
  • 404playbook not found or playbook_id missing
Petición
curl -X GET 'https://api.vixiees.com/api/v1/dashboard/pending_tasks?playbook_id=507f1f77bcf86cd799439011' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "summary_cards": {
    "total_pending_today": 10,
    "active_now": 3,
    "scheduled_today": 5,
    "priority_1_total": 2,
    "total_completed": 0
  },
  "hourly_distribution": [
    {
      "hour": "09:00",
      "count": 4,
      "is_current_hour": false,
      "is_high_activity": true
    }
  ],
  "by_user": [
    {
      "user_id": "507f1f77bcf86cd799439011",
      "user_name": "Ana García",
      "user_initials": "AG",
      "total_pending": 7,
      "total_completed": 3,
      "task_types": [
        {
          "task_template_id": "507f1f77bcf86cd799439012",
          "task_template_identifier": "Follow up",
          "priority": 1,
          "pending_count": 7,
          "completed_count": 3
        }
      ]
    }
  ],
  "by_task_type": [
    {
      "task_template_id": "507f1f77bcf86cd799439012",
      "task_template_identifier": "Follow up",
      "priority": 1,
      "total_pending": 7,
      "total_completed": 3,
      "users": [
        {
          "user_id": "507f1f77bcf86cd799439011",
          "user_name": "Ana García",
          "user_initials": "AG",
          "pending_count": 7,
          "completed_count": 3
        }
      ]
    }
  ]
}

Retrieves dashboard flow step transitions

get/dashboard/statuses

Returns contact transitions between flow steps (estados) for a given playbook and time period. Transitions are stored as daily totals. The period picks whole days (relative periods such as today are worked out in the account's time zone); transitions near midnight can fall on the adjacent day. Each entry shows the source state, destination state, number of transitions, and current contacts in destination.

Parámetros de consulta

  • playbook_idstringobligatorio
    ID of the playbook to filter by
    Ejemplo: 507f1f77bcf86cd799439011
  • periodstring
    Time period. custom requires start_date and end_date; other periods ignore the dates. If omitted, it becomes custom when start_date and/or end_date are sent (a missing date becomes today in the account's time zone), otherwise today.
    Valores:todayyesterdaythis_weeklast_weekthis_monthlast_monthlast_two_monthslast_7_dayslast_14_dayslast_30_dayslast_60_dayscustom
  • start_datestring (date)
    Start date (ISO 8601). Required when period is custom, ignored by other periods. Must be on or before end_date when both are sent.
    Ejemplo: 2024-01-01
  • end_datestring (date)
    End date (ISO 8601). Required when period is custom, ignored by other periods. Must be on or after start_date when both are sent.
    Ejemplo: 2024-01-31

Respuestas

  • 200statuses transitions returned
  • 401unauthorized
  • 404playbook not found or playbook_id missing
  • 422invalid period or date range
Petición
curl -X GET 'https://api.vixiees.com/api/v1/dashboard/statuses?playbook_id=507f1f77bcf86cd799439011' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
[
  {
    "estado_origen": "Lead",
    "estado_destino": "Contactado",
    "transiciones": 15,
    "contactos": 42
  }
]

Retrieves all playbook value dashboard data in one request

get/dashboard/playbook_value

Returns playbook value dashboard data in a single request: salesperson rows with flow step breakdown, global totals, and flow step metadata ordered by position. All views (table, scatter, bar chart) are derived client-side from this response.

Parámetros de consulta

  • playbook_idstringobligatorio
    ID of the playbook to filter by
    Ejemplo: 507f1f77bcf86cd799439011

Respuestas

  • 200playbook value data returned
  • 401unauthorized
  • 404playbook not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/dashboard/playbook_value?playbook_id=507f1f77bcf86cd799439011' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "rows": [
    {
      "user": {
        "id": "string",
        "full_name": "string",
        "email": "string",
        "initials": "string"
      },
      "total_contacts": 0,
      "total_amount": 0,
      "average_ticket": 0,
      "flow_steps": [
        {
          "id": "string",
          "name": "string",
          "won": true,
          "lost": true,
          "contacts": 0,
          "amount": 0
        }
      ]
    }
  ],
  "totals": {
    "total_contacts": 0,
    "open_contacts": 0,
    "won_contacts": 0,
    "total_amount": 0,
    "average_ticket": 0,
    "won_this_month_amount": 0
  },
  "flow_steps": [
    {
      "id": "string",
      "name": "string",
      "won": true,
      "lost": true,
      "position": 0,
      "contacts": 0,
      "amount": 0,
      "won_this_month_amount": 0
    }
  ],
  "won_month": "2026-06-01"
}