OpenAPI

Apps reviews

Query realtime App Store or Google Play reviews.

POST/v1/apps/reviews

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

Parameters

Send this request as a JSON body.

platformstringRequired

app_store · google_play

app_idstringOptional

bundle_idstringOptional

countrystringOptional

Default: "us"

langstringOptional

Default: "en"

pageintegerOptional

Default: 1

1 ≤ page ≤ ∞

countintegerOptional

Default: 20

1 ≤ count ≤ 100

Response

successbooleanRequired

dataobjectOptional

Show fields

reviewsarrayOptional

Show fields

authorstringOptional

ratingnumberOptional

titlestringOptional

contentstringOptional

datestringOptional

versionstringOptional

countrystringOptional

rawobjectOptional

cache_statusstringOptional

hit · miss · stale · bypass

upstream_endpointstringOptional

applied_paramsobjectOptional

raw_realtimeobjectOptional

App & Gaming 实时接口响应。

Show fields

sourcestringOptional

Default: "collectx"

endpointstringRequired

cache_statusstringRequired

hit · miss · stale · bypass

cached_atstringOptional

ttl_secondsintegerOptional

upstream_endpointstringRequired

applied_paramsobjectOptional

dataobjectOptional

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/reviews' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "platform": "google_play",
  "app_id": "example.app"
}'

This example is generated from the response schema.

Response example

{
  "success": true,
  "data": {
    "reviews": [
      {
        "author": null,
        "rating": null,
        "title": null,
        "content": null,
        "date": null,
        "version": null,
        "country": null,
        "raw": {}
      }
    ],
    "cache_status": "hit",
    "upstream_endpoint": "example",
    "applied_params": {},
    "raw_realtime": {
      "source": "collectx",
      "endpoint": "example",
      "cache_status": "hit",
      "cached_at": null,
      "ttl_seconds": null,
      "upstream_endpoint": "example",
      "applied_params": {},
      "data": null
    }
  },
  "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 →