Estadísticas

Los endpoints de Statistics ofrecen analíticas detalladas sobre tus apps y organizaciones. Puedes trackear los Monthly Active Users (MAU), el uso de almacenamiento y el consumo de ancho de banda en distintos periodos de tiempo. Estos datos son esenciales para monitorear el crecimiento de la app, el uso de recursos y la planificación de capacidad.

Entender las métricas

• MAU (Usuarios activos mensuales): Número de dispositivos únicos que accedieron a tu app en los últimos 30 días
• Almacenamiento: Tamaño total de todos los bundles y recursos almacenados en bytes
• Ancho de banda: Transferencia total de datos por la descarga de bundles en bytes

Buenas prácticas

1. Monitoreo regular: Revisa las estadísticas periódicamente para seguir el crecimiento y patrones de uso
2. Planificación de recursos: Usa métricas de almacenamiento y ancho de banda para planificar la capacidad
3. Engagement de usuarios: Rastrea el MAU para entender las tendencias de engagement
4. Gestión de costos: Monitorea el uso de recursos para optimizar costos

Endpoints

GET /statistics/app/:app_id/

Obtén estadísticas de una app específica. Este endpoint es útil para monitorear el rendimiento de cada app.

Parámetros de consulta

interface StatsQuery {
  from: Date  // Start date for the statistics (format: YYYY-MM-DD)
  to: Date    // End date for the statistics (format: YYYY-MM-DD)
}

Ejemplo de solicitud

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/statistics/app/com.demo.app/?from=2024-01-01&to=2024-02-01"

Ejemplo de respuesta

[
  {
    "date": "2024-01-01",
    "mau": 1500,
    "storage": 536870912,  // 512MB in bytes
    "bandwidth": 1073741824 // 1GB in bytes
  },
  {
    "date": "2024-01-02",
    "mau": 1550,
    "storage": 537919488,  // 513MB in bytes
    "bandwidth": 1074790400 // 1.01GB in bytes
  }
]

GET /statistics/org/:org_id/

Obtén estadísticas de una organización específica. Útil para monitorear el uso a nivel de organización.

Parámetros de consulta

interface StatsQuery {
  from: Date  // Start date for the statistics (format: YYYY-MM-DD)
  to: Date    // End date for the statistics (format: YYYY-MM-DD)
  breakdown: boolean  // default false, optional if true it return the breakdown by app
  noAccumulate: boolean // default false, optional if true it will not accumulate data and just return day by day result
}

Ejemplo de solicitud

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/statistics/org/046a36ac-e03c-4590-9257-bd6c9dba9ee8/?from=2024-01-01&to=2024-02-01"

Ejemplo de respuesta

[
  {
    "date": "2024-01-01",
    "mau": 10000,
    "storage": 536870912,   // 512MB in bytes
    "bandwidth": 1073741824  // 1GB in bytes
  },
  {
    "date": "2024-01-02",
    "mau": 10200,
    "storage": 537919488,   // 513MB in bytes
    "bandwidth": 1074790400  // 1.01GB in bytes
  }
]

GET /statistics/user/

Obtén estadísticas agregadas de todas las organizaciones a las que tienes acceso. Ideal para monitorear el uso general.

Parámetros de consulta

interface StatsQuery {
  from: Date  // Start date for the statistics (format: YYYY-MM-DD)
  to: Date    // End date for the statistics (format: YYYY-MM-DD)
}

Ejemplo de solicitud

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/statistics/user/?from=2024-01-01&to=2024-02-01"

Ejemplo de respuesta

[
  {
    "date": "2024-01-01",
    "mau": 25000,
    "storage": 1073741824,  // 1GB in bytes
    "bandwidth": 2147483648  // 2GB in bytes
  },
  {
    "date": "2024-01-02",
    "mau": 25500,
    "storage": 1074790400,  // 1.01GB in bytes
    "bandwidth": 2148532224  // 2.01GB in bytes
  }
]

GET /statistics/app/:app_id/bundle_usage

Obtén estadísticas de uso de bundles para una app específica, mostrando la distribución de bundles (versiones) entre los usuarios durante un periodo determinado.

Parámetros de consulta

interface BundleUsageQuery {
  from: Date  // Start date for the statistics (format: YYYY-MM-DD)
  to: Date    // End date for the statistics (format: YYYY-MM-DD)
}

Ejemplo de solicitud

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/statistics/app/com.demo.app/bundle_usage?from=2024-01-01&to=2024-02-01"

Ejemplo de respuesta

{
  "labels": ["2024-01-01", "2024-01-02", "2024-01-03"],
  "datasets": [
    {
      "label": "1.0.0",
      "data": [60.5, 58.2, 55.3]
    },
    {
      "label": "1.0.1",
      "data": [39.5, 41.8, 44.7]
    }
  ]
}

Manejo de errores

Todos los errores utilizan el formato estándar descrito en la visión general de API.

Escenarios de error comunes y sus respuestas:

// The API key cannot read this app (HTTP 401)
{
  "error": "no_access_to_app",
  "message": "No access to app",
  "moreInfo": { "data": "6aa76066-55ef-4238-ade6-0b32334a4097" }
}

// The API key cannot read this organization (HTTP 401)
{
  "error": "no_access_to_organization",
  "message": "No access to organization",
  "moreInfo": { "data": "6aa76066-55ef-4238-ade6-0b32334a4097" }
}

// Organization statistics require an active plan (HTTP 402)
{
  "error": "subscription_required",
  "message": "Organization subscription required or plan invalid",
  "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8", "isPayingAndGoodPlan": false }
}

// User statistics when the user belongs to no organization (HTTP 401)
{
  "error": "no_organizations_found",
  "message": "No organizations found",
  "moreInfo": { "data": "6aa76066-55ef-4238-ade6-0b32334a4097" }
}

Casos de uso comunes

1. Seguimiento de crecimiento: Monitorea el crecimiento de MAU en el tiempo
2. Optimización de recursos: Rastrea el uso de almacenamiento y ancho de banda para optimizar costos
3. Planificación de capacidad: Usa las tendencias para planificar necesidades futuras de recursos
4. Reportes de uso: Genera reportes de uso periódicos para los stakeholders
5. Análisis de distribución de bundles (versiones): Entiende cómo se distribuyen los usuarios en diferentes bundles (versiones) con estadísticas de uso

Consejos de análisis

1. Comparar periodos: Analiza tendencias mes a mes o año tras año
2. Seguimiento de ratios: Monitorea el ancho de banda por usuario o el almacenamiento por app
3. Configurar alertas: Crea alertas para detectar picos de uso inusuales
4. Backups regulares: Exporta estadísticas periódicamente para análisis históricos
5. Adopción de bundles (versiones): Usa el uso de bundles para medir la tasa de adopción de nuevas versiones

Sigue explorando las Statistics

Si estás usando Estadísticas para planificar el almacenamiento y la gestión de archivos, conéctalo con @capgo/capacitor-data-storage-sqlite para el detalle de implementación en @capgo/capacitor-data-storage-sqlite, Uso de @capgo/capacitor-data-storage-sqlite para la funcionalidad nativa en Uso de @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file para el detalle de implementación en @capgo/capacitor-file, Uso de @capgo/capacitor-file para la funcionalidad nativa en Uso de @capgo/capacitor-file, y @capgo/capacitor-uploader para el detalle de implementación en @capgo/capacitor-uploader.