Discovery

Published structure of one dataset (free, unmetered)

Dimensions, member codes and labels, totals, frequencies, periods, the ISO3 countries the dataset can serve, and whether it is servable. Use it to build a POST /v1/series request. Never metered.

countries lists an ISO3 code only when our country table holds it AND the publisher's own label for the source code names that country: a code's shape is never enough (Eurostat's FRA is its overseas-departments region and POL Polynesia; France is FR). Every other geography code is listed under aggregates, by its native code. Labels carry the dataset's language as lang (und when the catalog does not record it). On the frequency dimension each member states the ISO period frequency it serves (period_frequency: A, Q, M, or null when the structured path does not serve it). max_countries is how many geographies one request may name: 1 on readers that serve one geography per request (PxStat, PxWeb, StatBank, OData, DataStat, e-Stat, BDL, pindica).

On national PxWeb and PxStat tables a region axis can appear as an ordinary dimension: selecting a region member there returns that region's values, attributed to the national ISO3 the request named (the echo in resolved.select shows the region chosen). Unservable datasets (licence_unverified, no_data_path) answer from the catalog alone: no structure is fetched from the publisher, so dimensions is empty.

get/v1/datasets/{dataset_id}/structure

Request

  • Base URL: https://api.stackdata.io
  • URL: https://api.stackdata.io/v1/datasets/{dataset_id}/structure
  • Auth: one of:
    • none
    • API key in header X-API-Key

Path parameters

dataset_idstring required

Response

The structure view. A dataset that cannot be served says so here (servable: false with not_servable_reason) rather than being hidden.

datasetstring required
titlestring nullable
publisherstring
unitstring nullable
licenceobject
servableboolean required
not_servable_reasonstring nullable

Set when servable is false (e.g. licence_unverified, no_data_path, not_in_serve_set).

frequenciesstring[] required

Frequency codes served. An empty list means undeclared (the period's frequency is accepted and filtered after the fetch).

periodsobject nullable required

Declared coverage per frequency, {first, last} in ISO form. Null means undeclared.

countriesstring[] required

ISO 3166-1 alpha-3 codes this dataset can serve. Listed only when our country table holds the code and the publisher's label for its source code names that country.

max_countriesinteger required

How many distinct geographies one request may name. 25, or 1 on readers that serve one geography per request.

Changes

No recorded changes to this operation across all 1 revision of this API.