Statistiques

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

Comprendre les Métriques

• MAU (Utilisateurs Actifs Mensuels)Nombre de dispositifs uniques qui ont accédé à votre application au cours des 30 derniers jours
• StockageTaille totale de tous les bundles et ressources stockés en octets
• DébitTransfert de données total pour les téléchargements de bundles en octets

Meilleures Pratiques

1. Surveillance RégulièreVérifiez les statistiques périodiquement pour suivre la croissance et les modèles d'utilisation
2. Planification des Ressources: Utilisez les métriques de stockage et de bande passante pour la planification de la capacité
3. Engagement de l'Utilisateur: Suivez le nombre moyen d'utilisateurs actifs pour comprendre les tendances d'engagement de l'utilisateur
4. Gestion des Coûts: Surveillez l'utilisation des ressources pour optimiser les coûts

Points de Terminaison

GET /statistiques/app/:app_id/

Obtenez des statistiques pour une application spécifique. Cette méthode 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 les statistiques pour 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 /statistiques/utlisateur/

Obtenez des statistiques agrégées pour 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

Obtenez les statistiques d'utilisation des bundles pour une application spécifique, montrant la répartition des bundles (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

1. Suivi de la CroissanceSuivre l'évolution du nombre de utilisateurs actifs mensuels sur le long terme
2. Optimisation des RessourcesSuivre l'utilisation de stockage et de bande passante pour optimiser les coûts
3. Planification de CapacitéUtiliser les tendances pour planifier les besoins de ressources à venir
4. Rapports d'utilisation: Générer des rapports d'utilisation périodiques pour les parties prenantes
5. Analyse de la distribution du paquet (version): Comprendre comment les utilisateurs sont répartis sur différentes applications de paquets (versions) avec des statistiques d'utilisation de paquets

Conseils d'analyse

1. Comparer les périodes: Examiner les tendances du mois sur mois ou de l'année sur année
2. Suivre les ratios: Surveiller la bande passante par utilisateur ou le stockage par application
3. Définir les alertes: Créer des alertes pour des pics inhabituels d'utilisation
4. Sauvegardes régulières: Exporter les statistiques régulièrement pour une analyse historique
5. Adoption de l'ensemble (version): Utiliser l'utilisation des ensembles pour suivre les taux d'adoption de nouveaux ensembles (versions)