API Home

Version 2 (groups & weights) - Time Series Details

Released At: 25 Jan 2016Last Updated At: 26 Jan 2016

Get details about a time series.

URL

To call this method, use an HTTP GET request to the following URL:

http://data.unicef.ge/[locale]/api/v2/time_series

where:

[locale] = the locale of the language you want the data to be returned in (currently ka for Georgian or en for English)

Required Parameters

The following parameters must be included in the request:

Parameter	Description
access_token	All requests must include an access_token. You can obtain an access token easily, and for free, by going here.
time_series_id	The ID of the time series.

Optional Parameters

There following parameters are optional for this call.

Parameter	Description
language	Code of the language to return the time series information in (e.g., en for English). If language is not provided, the default language of the time series will be used.

What You Get

The return object is a JSON object of time series information with the following information:

Parameter	Description
id	Unique ID of the time series
url	URL to the time series
title	The title of the time series
description	A description of the time series, may include htmlmarkup
dates_included	An array of the dates that are included in the time series.The dates may represent a year, month/year, etc - there is no specific format for these values.
datasets	An array of the following information for each dataset that is part of the time series: dataset_id - the IF of the dataset label - the label used to represet the dataset in the time series title - the title of the dataset
public_at	Date the data was made public on this site, format: yyyy-mm-dd (e.g., 2015-01-31)
is_weighted	Flag indicating if the time series is weighted
categories	An array of the category names that have been assigned to this time series
countries	An array of the country names that the time series respresents
languages	An array of the languages that are available in this dateset
default_language	Thelanguage that is used by default
license	An object with the following values: title - the title of the license description - a brief description of the license url - a URL that contains more information about the license

Examples

Here is an example of what can be returned after calling this method with the following url:

http://data.unicef.ge/en/api/v2/time_series?access_token=123456789&time_series_id=1111111111

{
  {
    id: "1111111111",
    title: "This is a time series!",
    description: "This is an amazing time series!"
    dates_included: [
      "2009",
      "2011",
      "2013"
    ],
    datasets: [
      {
        dataset_id: "1111111111",
        label: "2009",
        title: "This is a dataset!"
      },
      {
        dataset_id: "22222222222",
        label: "2011",
        title: "This is another dataset!"
      },
      {
        dataset_id: "3333333333",
        label: "2013",
        title: "This is also dataset!"
      }
    ]
    public_at: "2015-03-01"
    is_weighted: false,
    categories: [
      "Education",
      "Finance"
    ],
    countries: [
      "Georgia"
    ]
    languages:[
      "en",
      "ka"
    ],
    default_language: "en",
    license: {
      title: "Open Data License",
      description: "This is a description about the license",
      url: null
    }
  }
}

API Home