Version 3 (categorical & numerical types) - Dataset Details
Released At: 25 Jan 2016Last Updated At: 10 Jul 2019
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/v3/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:
Parameter | Description |
---|---|
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.
Parameter | Description |
---|---|
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:
Parameter | Description |
---|---|
id | Unique ID of the dataset |
url | URL to the dataset |
title | The title of the dataset |
description | A description of the dataset, may include html markup |
source | The name of the source that gathered the data |
source_url | The URL to the source that gathered the data |
donor | Person(s) or organization(s) that funded the data collection |
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) |
total_responses | Number of responses in the datasets |
analyzable_questions | Number of questions the dataset has that can be analyzed |
is_weighted | Flag indicating if the dataset is weighted |
is_mappable | A boolean flag indicating if this dataset has at least one question that has been assigned to map shapes |
categories | An array of the category names that have been assigned to this dataset |
countries | An array of the country names that the dataset respresents |
languages | An array of the languages that are available in this dateset |
default_language | The language that is used by default |
methodology | The method in which the data was collected, may include html markup |
license |
An object with the following values:
|
reports |
An array of reports that have been written based on the dataset:
|
Examples
Here is an example of what can be returned after calling this method with the following url:
http://data.unicef.ge/en/api/v3/dataset?access_token=123456789&dataset_id=1111111111
{ { id: "1111111111", url: "http://data.unicef.ge/en/datasets/dataset1", title: "This is a dataset!", source: "People", start_gathered_at: "2014-04-01", end_gathered_at: "2014-06-30", released_at: "2015-01-01", public_at: "2015-03-01", total_responses: 453, analyzable_questions: 345, is_weighted: false, is_mappable: false, categories: [ "Education" ], countries: [ "Georgia" ] languages:[ "en", "ka" ], default_language: "en", methodology: "This data was gathered from by asking people questions!", license:{ title: "Open Data License", description: "This is a description about the license", url: null, } reports:[ { title: , summary: , language: "English", released_at: "2015-01-01", file_type: "PDF", url: "http://data.unicef.ge/system/datasets/1111111111/reports/this_is_a_report.pdf" } ] } }
Version 3 (categorical & numerical types)
- Dataset Catalog
- Dataset Details
- Dataset Codebook
- Dataset Analysis
- Time Series Catalog
- Time Series Details
- Time Series Codebook
- Time Series Analysis