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

Get timeseries list (filtered)

This endpoint returns timeseries data filtered by datasetId and a combination of dimension values.

Input: GET

With input as just the datasetId we obtain a list of all timeseries data listed in the dataset.

Input: POST

The StartDate and EndDate act as filters between which if data is found, a timeseries result is given as output. Similarly only data which matches the filter will be sent as output. By default if not Frequeny is given. All frequencies will be given as output. If not start and enddate is given..data from all time ranges will be given as output.

  • DimensionRequest :Dimension Filter Items
    • DimensionId : DimensionId to filter
    • Members : Members of the respective dimension Id which are required.
  • Frequency: Array of required Frequencies. values can be 'A' -Annual ,'Q' -Quarterly, 'M' -Monthly ,'W' -Weekly 
  • StartDate: StartDate from which data is required.
  • EndDate: EndDate before which data is required.

Result

Array of Observation Data details in JSON format:

  • DatasetId : unique dataset identifier
  • TimeSeriesKey : Timeseries identification number
  • frequency :Inverval of time between which observation data has been recorded.Can take the following values: annual, semiannual, quarterly, monthly, weekly, daily.
  • metadata : Lists out associated dimensions values for the given timeseries.
    • dim:Dimension Id
    • key: Unique Dimension key.
    • name: Value of the dimension
  • startDate: First observation value's date.
  • endDate: Last observation value's date.

Example

GET : http://knoema.com/api/1.0/data/dataset/CDIACTACHIINDUSAA
   
POST: http://knoema.com/api/1.0/data/dataset/CDIACTACHIINDUSAA
 
{
   "DimensionRequest": [
      {
         "DimensionId": "Location",
         "Members": [
            1000000,
            1000100
         ]
      },
      {
         "DimensionId": "Variable",
         "Members": [
            1000000,
            1000200
         ]
      }
   ],
   "Frequency": [
      "A",
      "Q",
      "M",
      "W"
   ],
   "StartDate": "1901-11-23",
   "EndDate": "2020-11-23"
}
 
 
[
   {
      "datasetId": "CDIACTACHIINDUSAA",
      "timeseriesKey": 1000000,
      "frequency": "Annual",
      "metadata": [
         {
            "dim": "Location",
            "key": "1000000",
            "name": "China"
         },
         {
            "dim": "Variable",
            "key": "1000000",
            "name": "anomalies"
         }
      ],
      "startDate": "1/1/1901 12:00:00 AM",
      "endDate": "1/1/1998 12:00:00 AM"
   }
]