Statistiques

Les endpoints de statistiques fournissent des analyses détaillées sur vos apps et vos organisations. Vous pouvez suivre les utilisateurs actifs mensuels (MAU), l'utilisation du stockage et la consommation de bande passante sur différentes périodes. Ces données sont essentielles pour surveiller la croissance de l'app, l'usage des ressources et planifier votre capacité.

Comprendre les métriques

• MAU (utilisateurs actifs mensuels): Nombre d'appareils uniques ayant accédé à votre app au cours des 30 derniers jours
• Stockage: Taille totale de tous les bundles et ressources stockés en octets
• Bande passante: Transfert de données total pour les téléchargements de bundles en octets

Bonnes pratiques

1. Suivi régulier: Vérifiez les statistiques périodiquement pour suivre la croissance et les habitudes d'utilisation
2. Planification des ressources: Use storage and bandwidth metrics for capacity planning
3. Engagement utilisateur: Track MAU to understand user engagement trends
4. Gestion des coûts: Monitor resource usage to optimize costs

Endpoints

GET /statistics/app/:app_id/

Récupérer les statistiques d'une application spécifique. Cet endpoint est utile pour surveiller les performances d'une application individuelle.

Paramètres de requête

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

Exemple de requête

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

Exemple de réponse

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

Récupérer les statistiques d'une organisation spécifique. Utile pour surveiller l'utilisation au niveau de l'organisation.

Paramètres de requête

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
}

Exemple de requête

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"

Exemple de réponse

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

Récupérez les statistiques agrégées de toutes les organisations auxquelles vous avez accès. Idéal pour surveiller votre usage global.

Paramètres de requête

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

Exemple de requête

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

Exemple de réponse

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

Récupérez les statistiques d'utilisation des bundles pour une application spécifique, affichant la répartition des bundles (versions) parmi les utilisateurs sur une période donnée.

Paramètres de requête

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

Exemple de requête

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"

Exemple de réponse

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

Gestion des erreurs

Toutes les erreurs utilisent le format d'erreur standard décrit dans la Aperçu de API.

Scénarios d'erreur courants et leurs réponses :

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

Cas d'usage courants

1. Suivi de la croissance: Surveillez la croissance des MAU au fil du temps
2. Optimisation des ressources: Suivez l'usage du stockage et de la bande passante pour optimiser les coûts
3. Planification de la capacité: Use trends to plan for future resource needs
4. Rapports d'usage: Générez des rapports d'usage périodiques pour vos parties prenantes
5. Analyse de la distribution des bundles (versions): Comprenez comment les utilisateurs sont répartis entre les différents bundles (versions) de l'app grâce aux statistiques d'usage des bundles

Conseils d'analyse

1. Comparer les périodes: Analysez les tendances mensuelles ou annuelles
2. Suivre les ratios: Surveillez la bande passante par utilisateur ou le stockage par app
3. Set Alerts: Créez des alertes pour les pics d'utilisation inhabituels
4. Sauvegardes régulières: Exportez régulièrement les statistiques pour une analyse historique
5. Adoption des bundles (versions): Utilisez l'usage des bundles pour suivre le taux d'adoption des nouveaux bundles (versions)

Continuer après les statistiques

Si vous utilisez Statistiques pour planifier le stockage et la gestion des fichiers, connectez-l’à @capgo/capacitor-data-storage-sqlite pour les détails d'implémentation dans @capgo/capacitor-data-storage-sqlite, Utiliser @capgo/capacitor-data-storage-sqlite pour la capacité native dans Utiliser @capgo/capacitor-data-storage-sqlite @capgo/capacitor-file pour les détails d'implémentation dans @capgo/capacitor-file, Utiliser @capgo/capacitor-file pour la capacité native dans Utiliser @capgo/capacitor-file, et @capgo/capacitor-uploader pour les détails d'implémentation dans @capgo/capacitor-uploader.