/ourworldindata/explorers/views

POST /api/ourworldindata/explorers/views

Price: 20 credits

Every view of an Our World in Data explorer: its choice per dimension, title, subtitle, note, chart types, default tab, the indicator ids or table columns it plots (with unit, description and source) and its URL.

How to use it

Lists the valid dimension combinations of one explorer in the explorer's own order, narrowed by any choices given. A view's url or choices go straight into ourworldindata/explorers/data.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• explorer string required — Explorer slug or URL (examples: "co2", "https://ourworldindata.org/explorers/population-and-demography"; minLength: 1)
• dimensions object nullable — Keep only views with these choices (examples: {"Gas or warming":"CO₂"})
  • * string
• count integer required — Max number of views to return (min: 1)

Response

• @type string (default: "OurWorldInDataView")
• url string required
• explorer string required
• choices array (default: [])
  • @type string (default: "OurWorldInDataSelectedChoice")
  • dimension string required
  • choice string required
• subtitle string nullable
• note string nullable
• chart_types array (default: [])
• default_tab string nullable
• has_map_tab boolean nullable
• default_entities array (default: [])
• indicator_ids array (default: [])
• column_slugs array (default: [])
• columns array (default: [])
  • @type string (default: "OurWorldInDataColumn")
  • alias string required
  • name string nullable
  • value_type string nullable
  • unit string nullable
  • short_unit string nullable
  • description string nullable
  • notes string nullable
  • source_name string nullable
  • source_url string nullable
  • published_by string nullable
  • publisher_source string nullable
  • retrieved_date string nullable
  • additional_info string nullable
  • indicator_id string nullable
• chart_id string nullable
• article_url string nullable
• is_default boolean (default: false)

Errors

• 422 — Unknown view dimension or choice 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 — Explorer not found 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.