Statistiques

Copiez un prompt de configuration avec les étapes d'installation et la guide Markdown complète pour ce plugin.

Les points de terminaison de statistiques fournissent des données détaillées sur les applications et les organisations. Vous pouvez suivre les utilisateurs actifs mensuels (MAU), l'utilisation de stockage et la consommation de bande passante sur différentes périodes de temps. Ces données sont essentielles pour suivre la croissance des applications, l'utilisation des ressources et la planification de la capacité.

Comprendre les Métriques

Utilisateurs actifs mensuels (MAU): Nombre de dispositifs uniques qui ont accédé à votre application au cours des 30 derniers jours
Stockage: Taille totale de tous les bundles et ressources stockés en octets
Bandwidth: Total des transferts de données pour les téléchargements de bundles en octets

Meilleures Pratiques

Surveillance régulière: Vérifiez les statistiques périodiquement pour suivre la croissance et les modèles d'utilisation
Planification des ressources: Utilisez les métriques de stockage et de bande passante pour la planification de capacité
Engagement des utilisateurs: Suivre le MAU pour comprendre les tendances d'engagement des utilisateurs
La gestion des coûts: Suivre l'utilisation des ressources pour optimiser les coûts

Les points de terminaison

GET /statistics/app/:app_id/

Obtenir des statistiques pour une application spécifique. Cet endpoint est utile pour surveiller les performances individuelles d'une application.

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 /statistiques/org/:org_id/

Obtenir des statistiques pour une organisation spécifique. Utile pour surveiller l'utilisation au niveau d'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 /statistiques/utlisateur/

Obtenez des statistiques agrégées sur toutes les organisations auxquelles vous avez accès. Parfait pour le suivi de l'utilisation globale.

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 /statistiques/app/:app_id/utilisation_du_paquet

Obtenir les statistiques d'utilisation des paquets pour une application spécifique, affichant la répartition des paquets (versions) parmi les utilisateurs sur une période spécifié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

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

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

Utilisations courantes

Suivi de la croissanceSuivre la croissance du MAU au fil du temps
Optimisation des ressourcesSuivre l'utilisation de stockage et de bande passante pour optimiser les coûts
Planification de capacitéUtiliser les tendances pour planifier les besoins futurs en ressources
Rapports d'utilisationGénérer des rapports d'utilisation périodiques pour les parties prenantes
Analyse de la distribution du bundle (version): Comprenez comment les utilisateurs sont répartis sur différentes versions de l'application (paquets) avec les statistiques d'utilisation des paquets

Conseils pour l'analyse

Comparer les périodes: Regardez les tendances mois sur mois ou année sur année
Suivre les ratios: Suivez la bande passante par utilisateur ou le stockage par application
Configurer les alertes: Créez des alertes pour des pics inhabituels d'utilisation
Sauvegardes régulières: Exportez les statistiques régulièrement pour une analyse historique
Adoption du paquet (version): Utilisez l'utilisation du bundle pour suivre les taux d'adoption de nouveaux bundles (versions)

Continuez d'ici 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, En utilisant @capgo/capacitor-data-storage-sqlite pour la capacité native dans En utilisant @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file pour les détails d'implémentation dans @capgo/capacitor-file, Utilisation du fichier @capgo/capacitor-file pour la capacité native dans Utilisation du fichier @capgo/capacitor-file, et l'uploader @capgo/capacitor-uploader pour le détail d'implémentation dans l'uploader @capgo/capacitor-uploader.