/tuik/datasets/dimensions

POST /api/tuik/datasets/dimensions

Price: 20 credits

List the dimensions of one TÜİK dataset with the full code list each one accepts

How to use it

Read this before slicing a dataflow: it names every axis the data is cut along and every code that axis actually takes, which is what a dimension filter has to be spelled with. Concepts in the attribute role qualify a cell rather than address it, so they cannot be filtered on. A concept with an empty values list is declared by the structure but carries no code list in this dataflow.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataflow code exactly as the catalogue publishes it, version suffix included (examples: "DF_ALTINSIZ_IHRACAT_BDE+V1.0", "DF_UHTI_HIZMET_TURU+V1.0"; minLength: 1)
• count integer required — Number of dimensions to return (min: 1)
• role string nullable — Keep only concepts playing this role in the dataflow (one of: "series", "observation", "attribute")
• lang string — Language of concept names and value labels (default: "tr"; one of: "tr", "en")

Response

• @type string (default: "TuikDimension")
• key string required
• dataset string required
• dataset_name string nullable
• code string required
• name string nullable
• role string required
• position integer nullable
• values array (default: [])
  • @type string (default: "TuikDimensionCode")
  • code string required
  • label string nullable
  • order integer nullable
  • parent_code string nullable
  • period_start string nullable
  • period_end string 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 — Dataflow code not found, or the dataset is catalogued without published observations 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.