含性能数据的应用列表
此端点返回您帐户下可请求性能数据的应用。您可以用它来确定其他性能端点所需的确切 applicationName 值,以及每个应用支持哪些指标。
端点
| 方法 | URL |
|---|---|
| GET | https://ws.catappult.io/api/statistics/availableApplications |
身份验证
要访问此 API,您需要在 Aptoide Connect 上拥有有效的帐户订阅,并使用 API 密钥进行身份验证(请查看此处了解如何生成密钥)。
⚠️
所需帐户类型
只有 Developer 类型的帐户才能获取性能数据。
请求头
| 请求头 | 类型 | 是否必需 | 说明 |
|---|---|---|---|
Api-Key | string | 必需 | 用于对您的 API 请求进行身份验证。该值是您的 Aptoide Connect API 密钥。 |
查询参数
此端点不接受任何查询参数。
响应
成功
如果 API 调用返回 HTTP 200 状态码,则表示请求成功,并返回一个应用的 JSON 数组。空数组表示该帐户下没有任何拥有性能数据的应用。
| 字段 | 类型 | 说明 |
|---|---|---|
applicationName | string | 传递给其他性能端点作为 applicationName 的包名。 |
applicationTitle | string | 应用的显示名称。 |
applicationIconUrl | string | 应用图标的 URL。 |
operatingSystemName | string | 该条目所对应的平台,取值为 android 或 ios。同一个包名在每个平台上各出现一次。 |
showSalesData | boolean | 是否可为该应用请求 revenue。 |
showInstallsData | boolean | 是否可为该应用请求 installs。 |
showDownloadsData | boolean | 是否可为该应用请求 downloads。 |
minFromDate | string | 存在性能数据的最早日期。 |
maxToDate | string | 可获取性能数据的最晚日期;若没有上限则为 null。 |
isCurrentOwner | boolean | 该帐户当前是否拥有此应用。 |
billing | object | 应用的计费集成信息,包含 hasBilling 和 method。 |
💡
同一个包名可能出现两次
包名在每个平台内唯一,而非全局唯一,因此同时在 Android 和 iOS 上发布的应用会以两个条目出现,二者的 applicationName 相同而 operatingSystemName 不同。请向其他性能端点传入 operatingSystem 来指定其中之一。
响应示例
[
{
"applicationIconUrl": "https://cdn-catappult.aptoide.com/icon/example-icon.png",
"applicationName": "com.example.test",
"applicationTitle": "Example App",
"billing": {
"hasBilling": true,
"method": "catappult-sdk",
"verifiedMethod": "sdk"
},
"isCurrentOwner": true,
"marketingRating": null,
"maxToDate": null,
"minFromDate": "2024-05-09 06:50:41",
"operatingSystemName": "android",
"showDownloadsData": false,
"showIncludedMarketingValueSummary": false,
"showInstallsData": true,
"showSalesData": true,
"showSalesSummary": false
}
]
⚠️
可用性标志并不保证一定有数据
showSalesData、showInstallsData 和 showDownloadsData 描述的是该应用的集成所支持的能力。对于没有已审核通过并已分发版本的应用,即使这些标志为 true,性能端点仍会返回 INVALID-TYPE 错误,且允许的类型列表为空。
错误
| 代码 | HTTP 状态 | 说明 | 解决方法 |
|---|---|---|---|
| — | 401 Unauthorized | API 密钥无法识别 | 请检查密钥,以及帐户是否已通过审核 |
SUBSCRIPTION-REQUIRED | 402 Payment Required | 没有有效的帐户订阅 | 请为该帐户开通订阅 |
DAILY-QUOTA-REACHED | 429 Too Many Requests | 超出每日请求配额 | 请在 UTC 午夜配额重置后重试 |