Skip to main content

API - Analytics y Dashboard

Visión General​

Endpoints para obtener métricas, estadísticas y datos analíticos del dashboard principal y reportes avanzados.

GET /count/main-dashboard-ministatistics​

Obtener estadísticas para el dashboard principal.

Response Success (200)​

{
  "success": true,
  "data": {
    "total_properties": 45,
    "active_contracts": 32,
    "pending_requests": 8,
    "monthly_revenue": 28500000,
    "this_month": {
      "new_properties": 5,
      "new_contracts": 3,
      "revenue_growth": 12.5
    },
    "charts": {
      "monthly_revenue": [
        {"month": "Jan", "amount": 25000000},
        {"month": "Feb", "amount": 28500000}
      ],
      "properties_by_status": [
        {"status": "available", "count": 13},
        {"status": "occupied", "count": 32}
      ]
    }
  }
}

GET /dashboard/metrics/overview​

Obtener métricas generales del sistema.

Response Success (200)​

{
  "success": true,
  "data": {
    "users": {
      "total": 156,
      "active_this_month": 142,
      "new_this_month": 12,
      "by_profile": {
        "owners": 45,
        "tenants": 89,
        "agents": 18,
        "admins": 4
      }
    },
    "properties": {
      "total": 78,
      "available": 23,
      "occupied": 45,
      "maintenance": 7,
      "inactive": 3,
      "average_price": 1250000,
      "total_value": 97500000
    },
    "contracts": {
      "total": 156,
      "active": 45,
      "expired": 89,
      "pending": 12,
      "cancelled": 10,
      "average_duration": "12 months"
    },
    "financial": {
      "total_revenue_this_month": 56750000,
      "total_revenue_last_month": 52300000,
      "growth_percentage": 8.5,
      "pending_payments": 8950000,
      "overdue_payments": 2100000
    }
  }
}

GET /dashboard/metrics/revenue​

Obtener métricas financieras detalladas.

Query Parameters​

  • period: Periodo (daily, weekly, monthly, yearly)
  • start_date: Fecha de inicio (YYYY-MM-DD)
  • end_date: Fecha de fin (YYYY-MM-DD)

Response Success (200)​

{
  "success": true,
  "data": {
    "period": "monthly",
    "total_revenue": 340500000,
    "revenue_by_month": [
      {
        "month": "2024-01",
        "revenue": 52300000,
        "contracts_count": 42,
        "properties_count": 38
      },
      {
        "month": "2024-02",
        "revenue": 56750000,
        "contracts_count": 45,
        "properties_count": 41
      }
    ],
    "revenue_by_property_type": {
      "apartment": 180500000,
      "house": 125000000,
      "commercial": 35000000
    },
    "revenue_by_city": {
      "Bogotá": 195000000,
      "Medellín": 89500000,
      "Cali": 56000000
    },
    "predictions": {
      "next_month_estimate": 59200000,
      "confidence_level": 0.87
    }
  }
}

GET /dashboard/metrics/occupancy​

Obtener métricas de ocupación.

Response Success (200)​

{
  "success": true,
  "data": {
    "overall_occupancy_rate": 87.5,
    "occupancy_by_type": {
      "apartment": 92.3,
      "house": 85.7,
      "commercial": 78.2
    },
    "occupancy_by_city": {
      "Bogotá": 91.2,
      "Medellín": 86.8,
      "Cali": 82.4
    },
    "occupancy_trend": [
      {"month": "2024-01", "rate": 85.2},
      {"month": "2024-02", "rate": 87.5}
    ],
    "average_vacancy_period": "15 days",
    "properties_vacant_longest": [
      {
        "property_id": 25,
        "title": "Apartamento Centro",
        "days_vacant": 45,
        "last_occupied": "2023-12-15"
      }
    ]
  }
}

GET /dashboard/metrics/maintenance​

Obtener métricas de mantenimiento.

Response Success (200)​

{
  "success": true,
  "data": {
    "total_requests": 156,
    "requests_this_month": 18,
    "average_resolution_time": "2.3 days",
    "requests_by_status": {
      "pending": 5,
      "in_progress": 3,
      "completed": 142,
      "cancelled": 6
    },
    "requests_by_category": {
      "plumbing": 45,
      "electrical": 32,
      "cleaning": 28,
      "maintenance": 35,
      "security": 16
    },
    "cost_analysis": {
      "total_cost": 15600000,
      "average_cost": 100000,
      "cost_by_category": {
        "plumbing": 5400000,
        "electrical": 3200000,
        "cleaning": 2100000,
        "maintenance": 3500000,
        "security": 1400000
      }
    },
    "properties_most_requests": [
      {
        "property_id": 12,
        "title": "Casa Norte",
        "requests_count": 8,
        "total_cost": 850000
      }
    ]
  }
}

GET /dashboard/metrics/performance​

Obtener métricas de rendimiento del sistema.

Response Success (200)​

{
  "success": true,
  "data": {
    "user_activity": {
      "daily_active_users": 45,
      "weekly_active_users": 89,
      "monthly_active_users": 142,
      "session_duration_avg": "15 minutes",
      "bounce_rate": 12.5
    },
    "system_performance": {
      "api_response_time_avg": "120ms",
      "uptime_percentage": 99.97,
      "error_rate": 0.02,
      "total_api_calls": 15678,
      "successful_calls": 15675
    },
    "feature_usage": {
      "most_used_features": [
        {"feature": "property_list", "usage_count": 2456},
        {"feature": "contract_view", "usage_count": 1789},
        {"feature": "payment_history", "usage_count": 1234}
      ],
      "chatbot_interactions": {
        "total_conversations": 567,
        "successful_resolutions": 498,
        "satisfaction_rate": 87.8
      }
    }
  }
}

GET /reports/custom​

Generar reporte personalizado.

Query Parameters​

  • type: Tipo de reporte (financial, occupancy, maintenance, users)
  • period: Periodo (daily, weekly, monthly, quarterly, yearly)
  • start_date: Fecha de inicio
  • end_date: Fecha de fin
  • format: Formato (json, pdf, excel)
  • filters: Filtros adicionales (JSON)

Request Example​

GET /reports/custom?type=financial&period=monthly&start_date=2024-01-01&end_date=2024-02-29&format=json

Response Success (200)​

{
  "success": true,
  "data": {
    "report_id": "RPT-2024-001",
    "type": "financial",
    "period": "monthly",
    "generated_at": "2024-02-29T10:30:00Z",
    "data": {
      "summary": {
        "total_revenue": 115250000,
        "total_expenses": 23450000,
        "net_profit": 91800000,
        "profit_margin": 79.6
      },
      "detailed_breakdown": [
        {
          "month": "2024-01",
          "revenue": 52300000,
          "expenses": 11200000,
          "profit": 41100000
        },
        {
          "month": "2024-02",
          "revenue": 62950000,
          "expenses": 12250000,
          "profit": 50700000
        }
      ]
    },
    "download_links": {
      "pdf": "https://api.alojaplus.com/reports/download/RPT-2024-001.pdf",
      "excel": "https://api.alojaplus.com/reports/download/RPT-2024-001.xlsx"
    }
  }
}

GET /analytics/predictions​

Obtener predicciones y análisis predictivo.

Response Success (200)​

{
  "success": true,
  "data": {
    "revenue_forecast": {
      "next_3_months": [
        {"month": "2024-03", "predicted": 59200000, "confidence": 0.87},
        {"month": "2024-04", "predicted": 61800000, "confidence": 0.82},
        {"month": "2024-05", "predicted": 63100000, "confidence": 0.76}
      ],
      "growth_trend": "positive",
      "growth_rate": 4.2
    },
    "occupancy_forecast": {
      "expected_rate_next_month": 89.2,
      "seasonal_trends": {
        "peak_months": ["March", "July", "December"],
        "low_months": ["January", "September"]
      }
    },
    "maintenance_predictions": {
      "properties_needing_attention": [
        {
          "property_id": 15,
          "probability": 0.78,
          "predicted_issue": "plumbing",
          "recommended_action": "preventive_inspection"
        }
      ],
      "budget_forecast": {
        "next_quarter": 5200000,
        "confidence": 0.71
      }
    }
  }
}

Tipos de Dashboard​

Executive Dashboard​

  • Métricas de alto nivel
  • KPIs principales
  • Tendencias generales

Operational Dashboard​

  • Métricas operativas
  • Solicitudes pendientes
  • Estado de propiedades

Financial Dashboard​

  • Análisis financiero
  • Flujo de caja
  • Rentabilidad

Maintenance Dashboard​

  • Estado de mantenimiento
  • Costos y tendencias
  • Programación de servicios