/dw/facets

POST /api/dw/facets

Price: 5 credits

List the values every dw/articles/search filter accepts in one Deutsche Welle language edition — content types, genres, priorities, surfaces, categories, kickers, regions, subjects and programs — each with how much content carries it.

How to use it

Call this before building a filtered dw/articles/search query. Category, kicker, region, subject and program values are written in the edition's own language, so the German edition answers 'Politik' where the English one answers 'Politics'; passing a value from the wrong edition returns nothing. content_count is the number of items DW currently indexes under that value. Set keyword to see how the values split for a specific query. Chinese (zh, zh-hant) has no search index.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Number of facet values to return (min: 1)
• language string — DW language edition (default: "en"; one of: "de", "en", "ar", "es", "ru", "fr", "uk", "tr", "fa-ir", "fa-af", "ps", "ur", "hi", "bn", "pt-br", "pt-002", "pl", "ro", "sr", "bs", "hr", "mk", "sq", "bg", "el", "zh", "zh-hant", "id", "sw", "ha", "am")
• facet array nullable — Limit the answer to these filter dimensions (one of: "media_type", "genre", "priority", "subdomain", "category", "kicker", "region", "subject", "program")
• keyword string — Count the values against this full text query instead of the whole edition (default: "")

Response

• @type string (default: "DwFacetValue")
• facet string required
• value string required
• content_count integer required

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 — This DW language edition has no search index 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.