/dw/sections

POST /api/dw/sections

Price: 5 credits

Get one Deutsche Welle section landing page by url or section id — the home page of an edition, a region desk or a subject desk — with every editorially curated module and the content it currently promotes.

How to use it

This is the front page as DW's editors composed it right now: modules[] keeps the module name (top_story, news, most_clicked, opinion, featured_video and so on) and the items placed in it. section accepts a full url, a path, or a bare id in the form 's-9097'; a plain number also works. Section ids come from dw/sections/search. Base url is https://www.dw.com.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• section string required — DW section url, path or bare section id (examples: "https://www.dw.com/en/top-stories/s-9097", "s-9097"; minLength: 1)
• language string — DW language edition, used when the identifier carries no language segment (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")

Response

• @type string (default: "DwSection")
• id integer required
• name string required
• alias string nullable
• language string nullable
• url string nullable
• page_title string nullable
• meta_description string nullable
• social_description string nullable
• is_indexed boolean nullable
• is_rtl boolean nullable
• is_media_template boolean nullable
• visible_in_web_app boolean nullable
• modules array (default: [])
  • @type string (default: "DwSectionModule")
  • id integer nullable
  • module string required
  • order integer nullable
  • item_count integer nullable
  • contents array (default: [])
    • @type string (default: "DwContentRef")
    • id integer required
    • content_type string nullable
    • headline string required
    • alias string nullable
    • url string nullable
    • language string nullable
    • subdomain string nullable
    • teaser string nullable
    • short_teaser string nullable
    • image string nullable
    • image_caption string nullable
    • content_at integer nullable
    • kicker string nullable
    • priority string nullable
    • genre string nullable
    • is_opinion boolean nullable
    • is_live_video boolean nullable
    • is_liveblog_active boolean nullable
    • duration integer nullable
    • formatted_duration string nullable
    • hls_url string nullable
    • mp3_url string nullable
    • poster_image string nullable
    • playback_format string nullable
    • image_count integer nullable
    • subtitles array (default: [])
    • programs array (default: [])
    • authors array (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 DW section with this id in this language edition 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.