Statistics

复制一个设置提示，包含安装步骤和该插件的完整Markdown指南。

统计API提供了关于您的应用和组织的详细分析。您可以跟踪每月活跃用户（MAU）、存储使用情况和带宽消耗在不同时间段内。这些数据对于监控应用增长、资源使用情况和规划容量至关重要。

理解指标

MAU（每月活跃用户）: 最近30天访问您的应用的唯一设备数量
存储:所有包和资源的总大小（以字节为单位）
带宽:所有包下载的总数据传输量（以字节为单位）

最佳实践

:定期检查统计数据以跟踪增长和使用模式资源规划
:使用存储和带宽指标进行容量规划用户参与度
:跟踪活跃用户数以了解用户参与度趋势存储
成本管理: 监控资源使用情况以优化成本

端点

GET /statistics/app/:app_id/

获取特定应用的统计数据。该端点有助于监控单个应用的性能。

查询参数

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

示例请求

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

示例响应

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

获取特定组织的统计数据。有助于监控组织级别的使用情况。

查询参数

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
}

示例请求

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"

示例响应

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

获取您有权访问的所有组织的聚合统计数据。适合用于监控整体使用情况。

查询参数

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

示例请求

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

示例响应

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

获取特定应用的包使用统计信息，显示用户在指定时间段内对包（版本）的分布。

查询参数

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

示例请求

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"

示例响应

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

错误处理

常见错误场景及其响应:

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

常见用例

增长跟踪:监控MAU增长趋势
资源优化:跟踪存储和带宽使用情况以优化成本
容量规划:使用趋势来规划未来资源需求
使用报告:为利益相关者生成周期性使用报告
包（版本）分发分析:了解用户如何分布在不同应用程序包（版本）上的包使用统计

分析提示

比较周期:查看月度或年度趋势
跟踪比例:监控每个用户的带宽或每个应用的存储
设置警报:创建异常使用峰值的警报
定期备份:定期导出统计数据进行历史分析
版本包（版本）采用率:使用版本包使用率来跟踪新版本包的采用率

继续从统计中前进

如果您正在使用统计与 @capgo/capacitor-sqlite-数据存储进行存储和文件处理的实现细节，请参阅@capgo/capacitor-data-storage-sqlite 使用@capgo/capacitor-data-storage-sqlite 进行本机能力的实现细节，请参阅使用@capgo/capacitor-data-storage-sqlite @capgo/capacitor文件进行存储和文件处理的实现细节，请参阅@capgo/capacitor-file 使用@capgo/capacitor-file 为使用@capgo/capacitor文件，和 @capgo/capacitor上传器为@capgo/capacitor上传器的实现细节