HDX Metadata
A reference for the dataset and resource fields available on HDX.
This page explains the main metadata fields available for download on each HDX dataset page. This is available in either JSON or CSV formats.
Metadata is data that defines and describes data. There are two types of metadata schemas used on HDX:
Dataset schema: Describing the entire dataset. We define datasets on HDX as the main unit or container describing data on HDX.
Resource schema: Describing the resources within a dataset. A resource is a sub-container within a dataset. A resource can contain files such as a CSV file, Excel spreadsheet, or PDF document.
Dataset Metadata Schema
Dataset ID
Unique identification number for each dataset.
id
Text
Title of Dataset
Name of the dataset.
title
Text
Dataset URL
Dataset URL slug.
name
Text
Description
Description of the dataset.
notes
Text
Source
Entity that collected or generated the data.
dataset_source
Text
Contributor
Organization that published the dataset.
organization
Defined list. See full list of organizations on HDX here.
Time period of the dataset
Date or date range the data covers. If ongoing, the end date is set to the current date.
dataset_date
Date or date range
Updated
Date when the dataset was last modified on HDX.
last_modified
Date
Expected update frequency
How often the data is expected to be updated on HDX.
data_update_frequency
Defined list:
-2: "As needed",
-1: "Never",
0: "Live",
1: "Daily",
2: "2 days",
7: "Weekly",
14: "2 weeks",
60: "2 months",
90: "3 months",
120: "4 months",
300: "10 months",
365: "Yearly",
730: "2 years"
Location
Countries or areas the dataset relates to.
groups
Defined listSee full list of locations on HDX here
License
License governing reuse of the data.
license_title
Defined listSee full list of licenses used on HDX here
Define license
Full terms when a custom license is used.
license_other
Text
Methodology
How the data was collected (survey, registry, etc.).
methodology
Defined list
Define methodology
Details when "Other" methodology is selected.
methodology_other
Text
Caveats/Comments
Notes on data quality or limitations.
caveats
Text
Resource Metadata Schema
A dataset can contain multiple resources and the resource’s position is reflected in each field name (e.g. resource_1_created).
Created
Date when the resource was first created on HDX.
resource_X_created
Date
Resource Description
Short description of the resource’s contents.
resource_X_description
Text
File Format
File format of the individual resource.
resource_X_format
See full list of formats supported by HDX
Download URL
URL to download the file from HDX.
resource_X_download_url
URL
Resource ID
Unique identification number for each resource on HDX.
resource_X_id
Text
Updated
Date when the resource was last modified on HDX.
resource_X_last_modified
Date
Metadata Updated
Date metadata for the resource was last modified on HDX.
resource_X_metadata_modified
Date
Microdata
Whether the resource contains microdata.
resource_X_microdata
Defined list:
FALSE
TRUE
Dataset ID
ID of the dataset this resource belongs to.
resource_X_dataset_id
Text
Resource Type
Indicates whether a file has been uploaded directly to HDX's servers or is a link to data stored elsewhere.
resource_X_resource_type
Defined list:
file.upload
Resource Name
Resource title shown on HDX.
resource_X_name
Text
MIME type
Media type of the resource file.
resource_X_mimetype
Text
Size
Size of the resource in kilobytes (KB) or megabytes (MB). For files that aren’t hosted on HDX, this may not always be available.
resource_X_size
Text
Last updated
Was this helpful?