OpenAPI

Apps rank history

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

POST/v1/apps/rank-history

Authentication: X-API-Key
Required scope: apps:rank-history:read
Billing: Pricing follows your active account rules
Rate limits: View your active rate limits

Parameters

Send this request as a JSON body.

ranking_typestringOptional

Default: "store_rank"

store_rank · pre_order

periodstringRequired

weekly · monthly

start_datestringRequired

end_datestringRequired

platformstringOptional

app_store · google_play

scopestringOptional

chart_typestringOptional

country_idstringOptional

genre_idstringOptional

app_idstringOptional

diandian_idstringOptional

osstringOptional

areastringOptional

categorystringOptional

limitintegerOptional

Default: 60

1 ≤ limit ≤ 120

Response

successbooleanRequired

dataobjectOptional

单应用榜单历史响应。

Show fields

sourcestringRequired

periodstringRequired

weekly · monthly

metric_keystringOptional

Default: "genre_ranking"

start_datestringRequired

end_datestringRequired

applied_filtersobjectOptional

pointsarrayOptional

Show fields

datestringRequired

valueintegerRequired

rankintegerRequired

metric_keystringOptional

Default: "genre_ranking"

errorobjectOptional

错误详情

Show fields

codeintegerRequired

业务错误码

messagestringRequired

可读错误信息

metaobjectOptional

响应元数据

Show fields

request_idstringOptional

请求唯一标识

Default: ""

pageintegerOptional

当前页码

sizeintegerOptional

每页数量

totalintegerOptional

总数

quota_remainingintegerOptional

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

Default: -1

service_levelstringOptional

本次请求的服务等级

langstringOptional

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

platformstringOptional

本次请求的达人平台

recall_typestringOptional

召回类型：hybrid / vector / scalar

credits_consumedintegerOptional

本次请求扣减的积分数

Default: 0

credits_remainingintegerOptional

积分余额（-1 不限制）

Default: -1

billable_unitsintegerOptional

Server-calculated billable units for this response

Default: 0

0 ≤ billable_units ≤ ∞

skill_namestringOptional

调用方 skill 名称

skill_current_versionstringOptional

调用方 skill 当前版本

skill_latest_versionstringOptional

服务端声明的最新 skill 版本

skill_min_supported_versionstringOptional

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

skill_update_availablebooleanOptional

是否存在可用 skill 更新

Default: false

skill_update_requiredbooleanOptional

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

Default: false

skill_update_messagestringOptional

skill 更新提示文案

skill_update_manifest_urlstringOptional

skill 更新 manifest URL

Request example

curl -X POST 'http://api.creativault.vip/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"
}'

This example is generated from the response schema.

Response example

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

View error handling →