Version 1 - Dataset Details

Released At: 29 Apr 2015Last Updated At: 02 Nov 2015

Get details about a dataset.

URL

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

http://data.unicef.ge/[locale]/api/v1/dataset

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:

ParameterDescription
access_token All requests must include an access_token. You can obtain an access token easily, and for free, by going here.
dataset_id The ID of the dataset.

Optional Parameters

There following parameters are optional for this call.

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

What You Get

The return object is a JSON objectof dataset informationwith the following information:

ParameterDescription
id Unique ID of the dataset
title The title of the dataset
source The name of the source that gathered the data
source_url The URL to the source that gathered the data
description A description of the dataset, may include htmlmarkup
start_gathered_at Date the data gathering process started, format: yyyy-mm-dd (e.g., 2015-01-31)
end_gathered_at Date the data gathering process finished, format: yyyy-mm-dd (e.g., 2015-01-31)
released_at Date the data was released to the public by the source, format: yyyy-mm-dd (e.g., 2015-01-31)
public_at Date the data was made public on this site, format: yyyy-mm-dd (e.g., 2015-01-31)
is_mappable A boolean flag indicating if this dataset has at least one question that has been assigned to map shapes
languages An array of the languages that are available in this dateset
default_language Thelanguage that is used by default
methodology Themethod in which the data was collected, may include htmlmarkup

Examples

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

http://data.unicef.ge/en/api/v1/dataset?access_token=123456789&dataset_id=1111111111
{
  {
    id: "1111111111",
    title: "This is a dataset!",
    source: "People",
    source_url: "http://somewhere.org",
    description: "This is an amazing dataset!",
    start_gathered_at: "2014-04-01",
    end_gathered_at: "2014-06-30",
    released_at: "2015-01-01",
    public_at: "2015-03-01",
    is_mappable: false,
    languages:[
      "en",
      "ka"
    ],
    default_language: "en",
    methodology: "This data was gathered from by asking people questions!"
  }
}