Statistiques

Les points de terminaison Statistiques fournissent des analyses détaillées sur vos applications et 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 des applications, l’utilisation des ressources et la capacité de planification.

Comprendre les métriques

MAU (Utilisateurs actifs mensuels) : Nombre d’appareils 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
Bande passante : transfert de données total pour les téléchargements de bundles en octets

## meilleures pratiques

Surveillance régulière : vérifiez périodiquement les statistiques pour suivre les modèles de croissance et d’utilisation.
Planification des ressources : utilisez les métriques de stockage et de bande passante pour la planification des capacités
Engagement des utilisateurs : suivez MAU pour comprendre les tendances d’engagement des utilisateurs
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. Ce point de terminaison est utile pour surveiller les performances de chaque 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 demande

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/

Obtenez des 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 demande

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/utilisateur/

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

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 demande

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/bundle_usage

Obtenez des statistiques d’utilisation des offres groupées pour une application spécifique, montrant la répartition des offres groupées (versions) entre 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 demande

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’erreur 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"
}

Cas d’utilisation courants

Suivi de la croissance : surveillez la croissance du MAU au fil du temps
Optimisation des ressources : suivez l’utilisation du stockage et de la bande passante pour optimiser les coûts
Planification des capacités : utilisez les tendances pour planifier les futurs besoins en ressources
Rapports d’utilisation : générez des rapports d’utilisation périodiques pour les parties prenantes
Analyse de la distribution des bundles (versions) : comprenez comment les utilisateurs sont répartis entre différents bundles d’applications (versions) avec des statistiques d’utilisation des bundles

Conseils pour l’analyse

Comparez les périodes : examinez les tendances d’un mois à l’autre ou d’une année à l’autre
Track Ratios : surveillez la bande passante par utilisateur ou le stockage par application
Définir des alertes : créez des alertes en cas de pics d’utilisation inhabituels
Sauvegardes régulières : exportez régulièrement des statistiques pour une analyse historique
Adoption du bundle (version) : utilisez l’utilisation du bundle pour suivre les taux d’adoption des nouveaux bundles (versions)