DeveloperDocs.api

Apps rankings

Query all-app, download and revenue, store-rank, or pre-order rankings.

POST/v1/apps/rankings

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

DeveloperDocs.parameters

DeveloperDocs.jsonBody

ranking_typestringDeveloperDocs.required

all · download · revenue · store_rank · pre_order

date_monthstringDeveloperDocs.optional

data_datestringDeveloperDocs.optional

pageintegerDeveloperDocs.optional

DeveloperDocs.defaultValue: 1

1 ≤ page ≤ ∞

sizeintegerDeveloperDocs.optional

DeveloperDocs.defaultValue: 10

1 ≤ size ≤ 100

allow_realtimebooleanDeveloperDocs.optional

DeveloperDocs.defaultValue: false

keywordstringDeveloperDocs.optional

platformstringDeveloperDocs.optional

scopestringDeveloperDocs.optional

chart_typestringDeveloperDocs.optional

country_idstringDeveloperDocs.optional

genre_idstringDeveloperDocs.optional

osstringDeveloperDocs.optional

areastringDeveloperDocs.optional

categorystringDeveloperDocs.optional

price_typestringDeveloperDocs.optional

free · paid

in_app_purchasestringDeveloperDocs.optional

Y · N

ratingstringDeveloperDocs.optional

4_5 · 4_0 · 3_0 · unrated

release_datestringDeveloperDocs.optional

last_release_datestringDeveloperDocs.optional

languagestringDeveloperDocs.optional

DeveloperDocs.response

successbooleanDeveloperDocs.required

dataobjectDeveloperDocs.optional

rankings 接口响应。

DeveloperDocs.showFields

sourcestringDeveloperDocs.required

ranking_typestringDeveloperDocs.required

data_datestringDeveloperDocs.required

updated_atstringDeveloperDocs.optional

totalintegerDeveloperDocs.optional

DeveloperDocs.defaultValue: 0

applied_filtersobjectDeveloperDocs.optional

recordsarrayDeveloperDocs.optional

DeveloperDocs.showFields

rankintegerDeveloperDocs.optional

rank_changeintegerDeveloperDocs.optional

app_idstringDeveloperDocs.optional

bundle_idstringDeveloperDocs.optional

diandian_idstringDeveloperDocs.optional

app_namestringDeveloperDocs.optional

logo_urlstringDeveloperDocs.optional

developerstringDeveloperDocs.optional

developer_urlstringDeveloperDocs.optional

platformstringDeveloperDocs.optional

devicestringDeveloperDocs.optional

country_idstringDeveloperDocs.optional

countrystringDeveloperDocs.optional

categorystringDeveloperDocs.optional

genresarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

ratingnumberDeveloperDocs.optional

rating_countintegerDeveloperDocs.optional

rating_count_listarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

store_ratingnumberDeveloperDocs.optional

store_rating_countintegerDeveloperDocs.optional

store_rating_sequencearrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

store_screenshotsarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

store_languagesstringDeveloperDocs.optional

pricenumberDeveloperDocs.optional

price_unitstringDeveloperDocs.optional

price_labelstringDeveloperDocs.optional

release_datestringDeveloperDocs.optional

last_release_datestringDeveloperDocs.optional

versionstringDeveloperDocs.optional

descriptionstringDeveloperDocs.optional

store_urlstringDeveloperDocs.optional

is_adintegerDeveloperDocs.optional

is_tecdo_advintegerDeveloperDocs.optional

industriesarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

metric_keystringDeveloperDocs.optional

metric_valuenumberDeveloperDocs.optional

sourcestringDeveloperDocs.required

report_datestringDeveloperDocs.required

crawl_datestringDeveloperDocs.optional

update_timestringDeveloperDocs.optional

fallback_usedbooleanDeveloperDocs.optional

DeveloperDocs.defaultValue: false

fallback_reasonstringDeveloperDocs.optional

cache_statusstringDeveloperDocs.optional

hit · miss · stale · bypass

upstream_endpointstringDeveloperDocs.optional

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/rankings' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "ranking_type": "all",
  "page": 1,
  "size": 10
}'

DeveloperDocs.schemaExampleNotice

DeveloperDocs.responseExample

{
  "success": true,
  "data": {
    "source": "example",
    "ranking_type": "example",
    "data_date": "example",
    "updated_at": "example",
    "total": 0,
    "applied_filters": {},
    "records": [
      {
        "rank": null,
        "rank_change": null,
        "app_id": null,
        "bundle_id": null,
        "diandian_id": null,
        "app_name": null,
        "logo_url": null,
        "developer": null,
        "developer_url": null,
        "platform": null,
        "device": null,
        "country_id": null,
        "country": null,
        "category": null,
        "genres": null,
        "rating": null,
        "rating_count": null,
        "rating_count_list": null,
        "store_rating": null,
        "store_rating_count": null,
        "store_rating_sequence": null,
        "store_screenshots": null,
        "store_languages": null,
        "price": null,
        "price_unit": null,
        "price_label": null,
        "release_date": null,
        "last_release_date": null,
        "version": null,
        "description": null,
        "store_url": null,
        "is_ad": null,
        "is_tecdo_adv": null,
        "industries": null,
        "metric_key": null,
        "metric_value": null,
        "source": "example",
        "report_date": "example",
        "crawl_date": null,
        "update_time": null
      }
    ],
    "fallback_used": false,
    "fallback_reason": "example",
    "cache_status": "hit",
    "upstream_endpoint": "example"
  },
  "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 →