/vivo/apps/related

POST /api/vivo/apps/related

Price: 20 credits

Get the apps the vivo App Store cross-sells on one app's detail page, each tagged with the shelf it came from: people also installed, downloaded together, category picks, same editorial collection, and more from the same developer

How to use it

Cross-sell graph around one app in vivo's mainland-China storefront, addressed by numeric id, package name or store URL. Read `relation` to tell the shelves apart: the store has no developer page, so the 'more from this developer' shelf is where a publisher's other titles surface. These shelves are the store's own merchandising rather than a similarity ranking, and an app appears once even when several shelves list it. Rows carry the store's rich app record, so follow up with /vivo/apps only for the long description, the ICP filing and the security markers.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• app string required — Numeric vivo app id, Android package name, or a vivo App Store app URL carrying either (examples: "2028843", "com.tencent.mm", "https://h5.appstore.vivo.com.cn/#/details?app_id=40413"; minLength: 1)
• count integer required — Max number of related apps to return (min: 1; max: 100)

Response

• @type string (default: "VivoRelatedApp")
• id integer required
• name string required
• package_name string required
• short_name string nullable
• developer string nullable
• version string nullable
• version_code string nullable
• size_kb integer nullable
• download_count integer nullable
• rating number nullable
• rating_count integer nullable
• tagline string nullable
• description string nullable
• changelog string nullable
• icon string nullable
• screenshots array (default: [])
• video_url string nullable
• video_cover string nullable
• is_game boolean nullable
• is_online_game boolean nullable
• is_official boolean nullable
• has_ads boolean nullable
• category string nullable
• category_id integer nullable
• subcategories array (default: [])
• subcategory_ids array (default: [])
• badges array (default: [])
• md5 string nullable
• released_at integer nullable
• updated_at integer nullable
• privacy_policy_url string nullable
• icp_license string nullable
• icp_operator string nullable
• security_scans array (default: [])
• download_url string nullable
• relation string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No app with this id or package name in the vivo App Store catalog Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.