/ximalaya/albums/reviews

POST /api/ximalaya/albums/reviews

Price: 20 credits

List listener reviews and star ratings left on a Ximalaya album, with their replies

How to use it

Each review carries the reviewer's own rating out of ten on the default top_rated sort, so that sort is the way to read sentiment rather than an album's single averaged score; on newest and newest_all the score is almost always null. An album nobody has reviewed and an album id that does not exist both come back as an empty list, so confirm the album itself before reporting that it has no reviews. Reviewers and reply authors carry a user_id and user_url that resolve on ximalaya/users, so pull the full profile behind any review or reply that matters.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• album string required — Album id, or an album link of the form /album/{id} (examples: "81519744", "https://www.ximalaya.com/album/40121646"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 2000)
• sort string — Ordering. top_rated and newest return only reviews carrying written text; newest_all also includes ratings left without any text (default: "top_rated"; one of: "top_rated", "newest", "newest_all")

Response

• @type string (default: "XimalayaAlbumReview")
• id integer required
• album_id integer nullable
• text string nullable
• score integer nullable
• user_id integer nullable
• nickname string nullable
• user_url string nullable
• image string nullable
• region string nullable
• like_count integer nullable
• reply_count integer nullable
• play_progress integer nullable
• is_high_quality boolean nullable
• is_liked_by_anchor boolean nullable
• created_at integer nullable
• updated_at integer nullable
• replies array (default: [])
  • @type string (default: "XimalayaAlbumReviewReply")
  • id integer required
  • text string nullable
  • user_id integer nullable
  • nickname string nullable
  • user_url string nullable
  • image string nullable
  • region string nullable
  • like_count integer nullable
  • created_at integer nullable

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 — The entity was not found, or a precondition failed 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.