/hk01/issues/search

POST /api/hk01/issues/search

Price: 5 credits

Search the 1200 HK01 (香港01) issue dossiers (專題) by keyword over title and teaser. Returns dossier id, title, teaser, dossier type (特輯 / 議題), owning zone, cover image and timestamps.

How to use it

Find HK01 curated dossiers by topic. Empty keyword lists the whole dossier catalogue. Each item has id, issue_title, description (teaser), web_url, image, issue_type, zone_id/zone_name and published_at/created_at/updated_at. Feed id into hk01/issues or hk01/issues/articles.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string — Free-text query over dossier title and teaser. Leave empty to list every dossier (default: ""; examples: "颱風", "世界盃")
• count integer required — Max number of dossiers to return (min: 1; max: 1000)
• locale string — Host used to build the returned URLs (default: "zh-HK"; one of: "zh-HK", "zh-CN")

Response

• @type string (default: "Hk01IssueSearchResult")
• id integer required
• issue_title string required
• description string nullable
• web_url string nullable
• image string nullable
• issue_type string nullable
• zone_id integer nullable
• zone_name string nullable
• zone_url string nullable
• is_featured boolean (default: false)
• is_sponsored boolean (default: false)
• is_live boolean (default: false)
• published_at integer nullable
• created_at integer nullable
• updated_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.