Statistiche

Gli endpoint Statistici forniscono analisi dettagliate sulle tue app e organizzazioni. Puoi tenere traccia degli utenti attivi mensili (MAU), dell’utilizzo dello spazio di archiviazione e del consumo di larghezza di banda in diversi periodi di tempo. Questi dati sono essenziali per monitorare la crescita delle app, l’utilizzo delle risorse e la capacità di pianificazione.

Comprendere le metriche

MAU (Utenti attivi mensili): numero di dispositivi unici che hanno avuto accesso alla tua app negli ultimi 30 giorni
Archiviazione: dimensione totale di tutti i pacchetti e le risorse archiviate in byte
Larghezza di banda: trasferimento dati totale per download di bundle in byte

Migliori pratiche

Monitoraggio regolare: controlla periodicamente le statistiche per monitorare la crescita e i modelli di utilizzo
Pianificazione delle risorse: utilizza i parametri di archiviazione e larghezza di banda per la pianificazione della capacità
Coinvolgimento degli utenti: monitora il MAU per comprendere le tendenze del coinvolgimento degli utenti
Gestione dei costi: monitora l’utilizzo delle risorse per ottimizzare i costi

Endpoint

GET /statistiche/app/:app_id/

Ottieni statistiche per un’app specifica. Questo endpoint è utile per monitorare le prestazioni delle singole app.

Parametri della query

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

Richiesta di esempio

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

Esempio di risposta

[
  {
    "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
  }
]

OTTIENI /statistics/org/:org_id/

Ottieni statistiche per un’organizzazione specifica. Utile per monitorare l’utilizzo a livello di organizzazione.

Parametri della query

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
}

Richiesta di esempio

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"

Esempio di risposta

[
  {
    "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 /statistiche/utente/

Ottieni statistiche aggregate su tutte le organizzazioni a cui hai accesso. Perfetto per il monitoraggio dell’utilizzo complessivo.

Parametri della query

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

Richiesta di esempio

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

Esempio di risposta

[
  {
    "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

Ottieni statistiche sull’utilizzo dei bundle per un’app specifica, mostrando la distribuzione dei bundle (versioni) tra gli utenti in un periodo specificato.

Parametri della query

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

Richiesta di esempio

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"

Esempio di risposta

{
  "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]
    }
  ]
}

Gestione degli errori

Scenari di errore comuni e relative risposte:

// Invalid body
{
  "status": "Invalid body",
  "error": "Invalid date format or missing parameters"
}

// Permission denied
{
  "status": "You can't access this app",
  "error": "Insufficient permissions to access statistics"
}

// Permission denied for organization
{
  "status": "You can't access this organization",
  "error": "Insufficient permissions to access organization statistics"
}

// No organizations found for user statistics
{
  "status": "No organizations found",
  "error": "No organizations found"
}

// Internal server error
{
  "status": "Cannot get app statistics",
  "error": "Internal server error message"
}

Casi d’uso comuni

Monitoraggio della crescita: monitora la crescita del MAU nel tempo
Ottimizzazione delle risorse: monitora l’utilizzo dello spazio di archiviazione e della larghezza di banda per ottimizzare i costi
Pianificazione della capacità: utilizza le tendenze per pianificare le future esigenze di risorse
Rapporti sull’utilizzo: genera rapporti periodici sull’utilizzo per le parti interessate
Analisi della distribuzione del bundle (versione): comprendere come gli utenti sono distribuiti tra diversi app bundle (versioni) con statistiche sull’utilizzo del bundle

Suggerimenti per l’analisi

Confronta periodi: esamina le tendenze mese su mese o anno su anno
Rapporti traccia: monitora la larghezza di banda per utente o lo spazio di archiviazione per app
Imposta avvisi: crea avvisi per picchi insoliti di utilizzo
Backup regolari: esporta regolarmente le statistiche per l’analisi storica
Adozione del bundle (versione): utilizza l’utilizzo del bundle per monitorare i tassi di adozione dei nuovi bundle (versioni)