Statistiche

Gli endpoint Statistics forniscono analisi dettagliate sulle tue app e organizzazioni. Puoi monitorare i Monthly Active Users (MAU), l'utilizzo dello storage e il consumo di banda in diversi periodi di tempo. Questi dati sono essenziali per monitorare la crescita dell'app, l'uso delle risorse e pianificare la capacità.

Capire le metriche

• MAU (Utenti attivi mensili): Numero di dispositivi unici che hanno effettuato l'accesso alla tua app negli ultimi 30 giorni
• Storage: Dimensione totale di tutti i bundle e delle risorse memorizzate in byte
• Banda: Trasferimento dati totale per il download dei bundle in byte

Best practice

1. Monitoraggio regolare: Controlla periodicamente le statistiche per tracciare crescita e pattern di utilizzo
2. Pianificazione risorse: Usa le metriche di storage e banda per la pianificazione della capacità
3. Coinvolgimento degli utentiMonitora gli MAU per comprendere i trend di engagement degli utenti
4. Gestione costi: Monitora l'uso delle risorse per ottimizzare i costi

Endpoint

GET /statistics/app/:app_id/

Ottieni le statistiche di un'app specifica. Questo endpoint è utile per monitorare le performance della singola app.

Parametri di 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)
}

Esempio di richiesta

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

Risposta di esempio

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

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

Parametri di 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
}

Esempio di richiesta

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"

Risposta di esempio

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

Ottieni statistiche aggregate per tutte le organizzazioni a cui hai accesso. Ideale per il monitoraggio dell'utilizzo complessivo.

Parametri di 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)
}

Esempio di richiesta

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

Risposta di esempio

[
  {
    "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 le statistiche sull'utilizzo dei bundle per una specifica app, visualizzando la distribuzione dei bundle (versioni) tra gli utenti in un determinato periodo.

Parametri di 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)
}

Esempio di richiesta

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"

Risposta di esempio

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

Tutti gli errori seguono il formato standard descritto nella panoramica di API.

Scenari di errore comuni e relative risposte:

// 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" }
}

Casi d'uso comuni

1. Monitoraggio della crescita: Monitora la crescita degli MAU nel tempo
2. Ottimizzazione delle risorse: Monitora l'uso di storage e banda per ottimizzare i costi
3. Pianificazione della capacità: Usa i trend per pianificare il fabbisogno di risorse futuro
4. Report di utilizzo: Genera report periodici sull'utilizzo per gli stakeholder
5. Analisi distribuzione Bundle (versioni): Capisci come gli utenti sono distribuiti tra i vari bundle (versioni) con le statistiche di utilizzo

Suggerimenti per l'analisi

1. Confronta i periodi: Analizza i trend mensili o annuali
2. Monitora i ratio: Controlla la banda per utente o lo storage per app
3. Imposta alert: Crea alert per picchi di utilizzo anomali
4. Backup regolari: Esporta periodicamente le statistiche per analisi storiche
5. Adozione Bundle (versione): Usa i dati di utilizzo per tracciare l'adozione di nuovi bundle (versioni)

Continua dalle statistiche

Se stai usando Statistiche per pianificare lo storage e la gestione dei file, collegalo a @capgo/capacitor-data-storage-sqlite per i dettagli di implementazione in @capgo/capacitor-data-storage-sqlite, Utilizzo di @capgo/capacitor-data-storage-sqlite per la funzionalità nativa in Utilizzo di @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file per i dettagli di implementazione in @capgo/capacitor-file, Utilizzo di @capgo/capacitor-file per la funzionalità nativa in Using @capgo/capacitor-file, e @capgo/capacitor-uploader per i dettagli di implementazione in @capgo/capacitor-uploader.