OpenAPI

Apps metadata

Query available dates and filters for an app ranking type.

POST/v1/apps/metadata

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

Parameters

Send this request as a JSON body.

ranking_typestringRequired

all · download · revenue · store_rank · pre_order

Response

successbooleanRequired

dataobjectOptional

metadata 接口响应。

Show fields

ranking_typestringRequired

latest_datestringOptional

available_datesarrayOptional

Show fields

Schema details are unavailable for this endpoint.

filtersobjectOptional

availabilityarrayOptional

Show fields

Schema details are unavailable for this endpoint.

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

This example is generated from the response schema.

Response example

{
  "success": true,
  "data": {
    "ranking_type": "example",
    "latest_date": "example",
    "available_dates": [
      "example"
    ],
    "filters": {},
    "availability": [
      {}
    ]
  },
  "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 →