Statistiken

Die Statistik-Endpunkte liefern detaillierte Analysedaten zu Ihren Apps und Organisationen. Sie können die monatlichen aktiven Benutzer (MAU), den Speicherbedarf und die Bandbreitennutzung über verschiedene Zeitabschnitte verfolgen. Diese Daten sind für die Überwachung der App-Wachstum, der Ressourcenverwendung und die Planung der Kapazität unerlässlich.

Verständnis der Metriken

• MAU (monatlich aktive Benutzer): Anzahl der einzigartigen Geräte, die Ihre App in den letzten 30 Tagen zugriffen haben
• Speicher: Gesamter Speicherplatz aller Pakete und Ressourcen in Byte
• Bandbreite: Gesamtdatenübertragung für Paketdownloads in Byte

Best Practices

1. Regelmäßige Überwachung: Überprüfen Sie Statistiken regelmäßig, um Wachstum und Nutzungsmuster zu verfolgen
2. Ressourcenplanung: Verwenden Sie Speicher- und Bandbreitenmetriken für die Kapazitätsplanung
3. Benutzerbeteiligung: Verfolgen Sie die MAU, um Trends der Benutzerbeteiligung zu verstehen
4. Kostenmanagement: Überwachen Sie die Ressourcenverwendung, um Kosten zu optimieren

Endpunkte

GET /statistiken/app/:app_id/

Statistiken für eine bestimmte App abrufen. Dieser Endpunkt ist nützlich für die Überwachung der Leistung einzelner Apps.

Anfrageparameter

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

Beispielanfrage

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

Beispielantwort

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

Statistiken für eine bestimmte Organisation abrufen. Nützlich für die Überwachung der Organisationsebene.

Abfrageparameter

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
}

Beispielanfrage

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"

Beispielantwort

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

Gewonnene aggregierte Statistiken über alle Organisationen, denen Sie Zugriff haben. Perfekt für die Überwachung der Gesamtverwendung.

Abfrageparameter

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

Beispielanfrage

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

Beispiel-Antwort

[
  {
    "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 /statistiken/app/:app_id/paketverwendung

Abrufen von Paketverwendungsstatistiken für eine bestimmte App, die Verteilung von Paketen (Versionen) unter Benutzern über einen bestimmten Zeitraum zeigt.

Abfrageparameter

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

Beispielanfrage

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"

Beispielantwort

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

Fehlerbehandlung

Gemeinsame Fehlerfälle und ihre Antworten:

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

Gemeinsame Anwendungsfälle

1. WachstumstrackingÜberwachen Sie das monatliche aktive Benutzerwachstum im Laufe der Zeit
2. Ressourcenoptimierung: Speicherplatz- und Bandbreitenverbrauch verfolgen, um Kosten zu optimieren
3. Kapazitätsplanung: Trends nutzen, um zukünftige Ressourcenbedarfe zu planen
4. Nutzungsberichte: Periodische Nutzungsberichte für Stakeholder erstellen
5. Bundle (Version) Verteilungsanalyse: Verstehe, wie Benutzer über verschiedene App-Bundles (Versionen) verteilt sind, mit Bundle-Nutzungsstatistiken

Tipps zur Analyse

1. Vergleiche von Zeiträumen: Monat-zu-Monat- oder Jahr-zu-Jahr-Trends betrachten
2. Ratios verfolgen: Überwachen Sie die Bandbreite pro Benutzer oder den Speicher pro App
3. Benachrichtigungen einrichten: Erstellen Sie Benachrichtigungen für ungewöhnliche Spitzen in der Nutzung
4. Regelmäßige Sicherungen: Exportieren Sie Statistiken regelmäßig für eine historische Analyse
5. Bundle (Version) - Einführung: Verwenden Sie die Bundle-Nutzung, um die Einführungsraten neuer Bundles (Versionen) zu verfolgen