DeveloperDocs.api

Apps rank history

Query store-rank or pre-order history for one app.

POST/v1/apps/rank-history

DeveloperDocs.authentication: X-API-Key
DeveloperDocs.permission: apps:rank-history:read
DeveloperDocs.billing: DeveloperDocs.configuredBilling
DeveloperDocs.limits: DeveloperDocs.configuredLimits

DeveloperDocs.parameters

DeveloperDocs.jsonBody

ranking_typestringDeveloperDocs.optional

DeveloperDocs.defaultValue: "store_rank"

store_rank · pre_order

periodstringDeveloperDocs.required

weekly · monthly

start_datestringDeveloperDocs.required

end_datestringDeveloperDocs.required

platformstringDeveloperDocs.optional

app_store · google_play

scopestringDeveloperDocs.optional

chart_typestringDeveloperDocs.optional

country_idstringDeveloperDocs.optional

genre_idstringDeveloperDocs.optional

app_idstringDeveloperDocs.optional

diandian_idstringDeveloperDocs.optional

osstringDeveloperDocs.optional

areastringDeveloperDocs.optional

categorystringDeveloperDocs.optional

limitintegerDeveloperDocs.optional

DeveloperDocs.defaultValue: 60

1 ≤ limit ≤ 120

DeveloperDocs.response

successbooleanDeveloperDocs.required

dataobjectDeveloperDocs.optional

单应用榜单历史响应。

DeveloperDocs.showFields

sourcestringDeveloperDocs.required

periodstringDeveloperDocs.required

weekly · monthly

metric_keystringDeveloperDocs.optional

DeveloperDocs.defaultValue: "genre_ranking"

start_datestringDeveloperDocs.required

end_datestringDeveloperDocs.required

applied_filtersobjectDeveloperDocs.optional

pointsarrayDeveloperDocs.optional

DeveloperDocs.showFields

datestringDeveloperDocs.required

valueintegerDeveloperDocs.required

rankintegerDeveloperDocs.required

metric_keystringDeveloperDocs.optional

DeveloperDocs.defaultValue: "genre_ranking"

errorobjectDeveloperDocs.optional

错误详情

DeveloperDocs.showFields

codeintegerDeveloperDocs.required

业务错误码

messagestringDeveloperDocs.required

可读错误信息

metaobjectDeveloperDocs.optional

响应元数据

DeveloperDocs.showFields

request_idstringDeveloperDocs.optional

请求唯一标识

DeveloperDocs.defaultValue: ""

pageintegerDeveloperDocs.optional

当前页码

sizeintegerDeveloperDocs.optional

每页数量

totalintegerDeveloperDocs.optional

总数

quota_remainingintegerDeveloperDocs.optional

剩余配额（-1 表示不限制）

DeveloperDocs.defaultValue: -1

service_levelstringDeveloperDocs.optional

本次请求的服务等级

langstringDeveloperDocs.optional

响应语言（cn/en），为空表示未翻译

platformstringDeveloperDocs.optional

本次请求的达人平台

recall_typestringDeveloperDocs.optional

召回类型：hybrid / vector / scalar

credits_consumedintegerDeveloperDocs.optional

本次请求扣减的积分数

DeveloperDocs.defaultValue: 0

credits_remainingintegerDeveloperDocs.optional

积分余额（-1 不限制）

DeveloperDocs.defaultValue: -1

billable_unitsintegerDeveloperDocs.optional

Server-calculated billable units for this response

DeveloperDocs.defaultValue: 0

0 ≤ billable_units ≤ ∞

skill_namestringDeveloperDocs.optional

调用方 skill 名称

skill_current_versionstringDeveloperDocs.optional

调用方 skill 当前版本

skill_latest_versionstringDeveloperDocs.optional

服务端声明的最新 skill 版本

skill_min_supported_versionstringDeveloperDocs.optional

服务端声明的最低支持版本

skill_update_availablebooleanDeveloperDocs.optional

是否存在可用 skill 更新

DeveloperDocs.defaultValue: false

skill_update_requiredbooleanDeveloperDocs.optional

是否要求更新 skill 后再继续使用

DeveloperDocs.defaultValue: false

skill_update_messagestringDeveloperDocs.optional

skill 更新提示文案

skill_update_manifest_urlstringDeveloperDocs.optional

skill 更新 manifest URL

DeveloperDocs.requestExample

curl -X POST 'https://openapi.creativault.ai/openapi/v1/apps/rank-history' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "ranking_type": "store_rank",
  "period": "weekly",
  "start_date": "2026-08-01",
  "end_date": "2026-08-31",
  "platform": "app_store",
  "scope": "apps",
  "chart_type": "free",
  "country_id": "24",
  "genre_id": "6014"
}'

DeveloperDocs.schemaExampleNotice

DeveloperDocs.responseExample

{
  "success": true,
  "data": {
    "source": "example",
    "period": "weekly",
    "metric_key": "genre_ranking",
    "start_date": "example",
    "end_date": "example",
    "applied_filters": {},
    "points": [
      {
        "date": "example",
        "value": 1,
        "rank": 1,
        "metric_key": "genre_ranking"
      }
    ]
  },
  "error": null,
  "meta": {
    "request_id": "",
    "page": 1,
    "size": 1,
    "total": 1,
    "quota_remaining": -1,
    "service_level": "example",
    "lang": "example",
    "platform": "example",
    "recall_type": "example",
    "credits_consumed": 0,
    "credits_remaining": -1,
    "billable_units": 0,
    "skill_name": "example",
    "skill_current_version": "example",
    "skill_latest_version": "example",
    "skill_min_supported_version": "example",
    "skill_update_available": false,
    "skill_update_required": false,
    "skill_update_message": "example",
    "skill_update_manifest_url": "example"
  }
}

DeveloperDocs.errorHelp →