NOnomics

Respond a list of series belonging to the same dataset.

get/series/{provider_code}/{dataset_code}/{series_code}

Request

Path parameters

provider_codestring required

The code of a provider.

dataset_codestring required

The code of a dataset.

If the dataset code ends with a format (e.g. .csv), some parameters will be preset: format=csv, observations=1 and align_periods=1. Also, the .csv suffix will be removed from the dataset code.

series_codestring required

A series code mask is an alternative way to express a dimension filter. Can't be used with dimensions parameter.

Series codes masks can designate many series by:

  • removing a constraint on a dimension, for example M..PCPIEC_WT;
  • enumerating many values for a dimension, separated by a '+', for example M.FR+DE.PCPIEC_WT;
    • if values contains '+', they can be protected with double quotes. Example: 'A+"FR+BE"' will enumerate series for 'A' and 'FR+BE' dimensions.
  • combining these possibilities many times in the same code mask.

If the rightmost dimension value code is removed, then the final '.' can be removed too: A.FR. = A.FR.

If the series code ends with a format (e.g. .csv), some parameters will be preset: format=csv and observations=1. Also, the .csv suffix will be removed from the series code.

Query parameters

dimensionsstring

JSON object describing the dimensions filtering the search. Can't be used with series_code parameter.

qstring

Full-text search query

facetsboolean

Return facets in response.

observationsboolean

Return observations for each series of the response.

metadataboolean

Return providers and datasets metadata in response.

format'csv' | 'json' | 'xlsx'

Format of the output. If using csv and response includes series of different frequencies, many CSV files will be produced, one per frequency, wrapped in a single ZIP file. Implies observations=1 automatically.

align_periodsboolean

Ensure that all the periods of each series are defined in every other series. Add NA (not available) values when needed. Must be used with parameter observations=1.

limitinteger

The numbers of items to return.

offsetinteger

The number of items to skip before starting to collect the result set.

Response

A list of series

datasetobject required
providerobject required
series_dimensions_facetsobject

Example response

{
  "_meta": {
    "version": "0.22.0"
  },
  "errors": [
    {
      "message": "Could not produce any series"
    }
  ],
  "series": {
    "docs": [
      {
        "dataset_code": "ZUTN",
        "provider_code": "AMECO",
        "series_code": "AUT.1.0.0.0.ZUTN"
      }
    ],
    "limit": 100,
    "num_found": 65
  }
}

Changes

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