An error occured. Details Hide
You have unsaved pages. Restore Cancel

Map timeseries to pivot descriptor

 
This endpoint returns pivot descriptor for the combination timeseriesKey and dataset provided.
 
Input: 
NameType Description 
datasetIdstring Unique identifier for dataset.
timeseriesKeyintTimeseries identification number
 
Output:
Name Type Description 
Dataset string Unique dataset id 
Header object Dimension details and members of header 
Contains array of 
  • DimensionId: Dimension id
  • Members: Distinct sorted values of dimension members
Stub Object 

Dimension details and members of stub 
Contains array of

  • DimensionId: Dimension id
  • Members: Distinct sorted values of dimension members
Filter ObjectDimension details of members which are used as a filter. This can 
contain only one member. 
Frequencieschar

Interval of time between which observation data is recorded. Values can be 'A' -Annual ,'Q' -Quarterly, 'M' -Monthly ,'W' -Weekly

FoldDimensionstringdimension Id which has fold applied on the members.
 
Example:
 
Result:
{
  "Dataset": "OMINF2016",
  "Header": [
    {
      "FilterText": null,
      "DimensionId": "Time",
      "Members": [
        "2002-2016"
      ],
      "UiMode": "range"
    }
  ],
  "Stub": [
    {
      "FilterText": null,
      "DimensionId": "region",
      "Members": [
        1000000
      ]
    },
    {
      "FilterText": null,
      "DimensionId": "indicator",
      "Members": [
        1000070
      ]
    },
    {
      "FilterText": null,
      "DimensionId": "periodic-release",
      "Members": [
        1000000
      ]
    },
    {
      "FilterText": null,
      "DimensionId": "program-quality",
      "Members": [
        1000000
      ]
    }
  ],
  "Filter": [],
  "Frequencies": [
    "A"
  ]
}