/tencentvideo/channels/rankings

POST /api/tencentvideo/channels/rankings

Price: 10 credits

Get a Tencent Video channel chart (hot search, rising, most rewatched, genre charts) in rank order: cover id, title, tagline, recommendation line, labels and update status

How to use it

Charts are per channel: tv publishes hot_search, soar, watch_again, female_audience and male_audience; variety adds hot_play and genre charts; documentary has hot_play only. A chart holds at most 30 entries. Pass `id` to tencentvideo/covers for the full record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• channel string required — Channel whose chart to read (one of: "tv", "variety", "documentary")
• chart string required — Chart name; each channel publishes its own set (one of: "hot_search", "soar", "hot_play", "watch_again", "female_audience", "male_audience", "game_shows", "relationship_shows", "music_shows", "comedy_shows", "talk_shows")
• count integer required — Max number of chart entries to return (min: 1; max: 30)

Response

• @type string (default: "TencentvideoChartEntry")
• rank integer required
• id string required
• url string required
• subtitle string nullable
• summary string nullable
• reason string nullable
• labels array (default: [])
• update_status string nullable
• access_label string nullable
• highlight string nullable
• preview_video_id string nullable
• image string nullable

Errors

• 422 — The chart is not published by the chosen channel. 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 channel does not currently publish this chart. 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.