> For the complete documentation index, see [llms.txt](https://docs.humdata.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.humdata.org/find/understanding-the-hdx-dataset-page.md).

# Understanding the HDX dataset page

This section explains how to interpret the information provided on HDX dataset pages and better understand the data being shared. Each dataset page consists of a fixed header section, left-hand menu that moves between tabs and Data and Resources section.

1. Dataset page header
2. Dataset details menu
3. Data and Resources

<div align="left" data-with-frame="true"><img src="https://2832631354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4eRiaTyCUWRqgHINBcpH%2Fuploads%2FaaEL9uJXJAq5kmXLaMqS%2FWP%20dataset%20page.png?alt=media&amp;token=e9451e6a-be72-4608-9490-9b3ff6e8e243" alt="Dataset page" width="563"></div>

### Dataset page header

* **Dataset title:** The dataset title typically includes the location and topic, such as "Afghanistan - Health Indicators" or "Nigeria - Food Prices".
* **Dataset description:** Provides details about the dataset, including its purpose, context and potential use. &#x20;
* **'Get Notified' button:** Click this button to subscribe to email notifications about changes to this dataset. See the Notifications page for more information.
* **Downloads count:** The total number of times the dataset has been downloaded.
* **Organization logo :** The logo of the organization that shared the dataset. Click on the logo to go to the organization page on HDX.&#x20;
* **Contact the contributor:** Click this link to send a message to the person or team responsible for the dataset. See the 'Contact the contributor' section below for information.
* **Key metadata:** The row below the description shows key metadata such as location, expected update frequency, time period and source (see full definitions of these in the Metadata section.
* **Data preview:** HDX creates a map automatically from geodata formats that it recognizes. Here is an [example of geodata](https://data.humdata.org/dataset/hotosm_lbn_roads) showing the preview feature.

### Data and Resources

This section lists all the files available to download.

<div align="left" data-with-frame="true"><img src="https://2832631354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4eRiaTyCUWRqgHINBcpH%2Fuploads%2FOvujmycyEfAjVhI6qgxa%2FWP%20dataset%20page-data%20and%20resources.png?alt=media&amp;token=be29d02d-c88a-4a5a-ace4-08a7e63715ad" alt="Data and Resources section of a dataset page" width="563"></div>

Each resource shows:

* **Format icon:** This icon displays the format of the resource file.
* **Resource name:** The name describes the file contents.&#x20;
* R**esource description:** Provides specific details about the resource, including its purpose, context and potential use.
* **Access via API:** Only shows on a tabular resource available through our Tabular Data Endpoint (TDE) API. Clicking the link takes you to the ‘API Access’ section on the Resource Page.&#x20;
* **Download button:** Click to download the file locally and directly to your computer. The file size is shown in parentheses.
* **More Information button:** Click to access the Resource Page.

### Metadata <a href="#docs-internal-guid-59851f75-7fff-a66b-9222-621d42a29f4c" id="docs-internal-guid-59851f75-7fff-a66b-9222-621d42a29f4c"></a>

This section contains metadata about the dataset.

* **Time period:** The date range that the data covers. For example, "01 January 2020 - 31 December 2024" means the data either contains information from that time period or is valid for that period.
* **Expected update frequency:** The frequency at which the data contributor plans to update the dataset. An ‘up to date’ label ("freshness") indicates that the dataset contains the latest available data. The calculation to determine if a dataset is up to date has been updated as of April 2025. It is as follows: End date + Frequency = cut-off date when data becomes out of date. Example: a dataset contains data from 01 January 2025 until 31 March 2025 and has an update frequency of every 3 months, it will appear as ‘up to date’ until the 30 June 2025.
* **Modified:** The date the  data contributor last updated the file.
* **Contributor:** The organization responsible for publishing the data on HDX, also represented by the logo at the top of the page.
* **Source:** The organization that collected or produced the data.&#x20;
* **Dataset Added on HDX:** The date that the datasets were first added to HDX.
* **Dataset ID:** A unique identifier for the dataset. Click the copy icon to copy this ID.
* **Location:** The country or countries the data relates to. Click the location name to go to the location page and find related datasets.
* **Methodology:** Information about how the data was collected or processed. A list of the types of methodology is linked here.
* **Caveats / Comments:** Important notes about the data, such as known issues, limitations, or special considerations for use.
* **License:** The open data license under which the data is available. See the section below on 'Understanding data licenses'.
* **Tags:** A tag is a term that a data contributor adds to a dataset’s metadata to describe or categorize the data. HDX maintains a list of approved tags here.
* **File Format:** The file format(s) the data is available in. HDX supports a range of file formats, a complete list of which you can find here.
* **Visibility:** Visibility metadata shows whether the dataset is public or private. Public data is openly available to download and access on HDX. Private datasets are only visible to members of an organization on HDX.&#x20;
* **Downloads:** A chart after the Metadata section showing downloads over recent months.

Additional features on the dataset page:

* **Showcases:** If you have a data visualization, documentation or related material in PDF format, you can add it as a showcase item on the dataset page.&#x20;
* **Activity:** Click the view a timeline of changes to the dataset, including when resources were added, updated, or removed.

### Resource page <a href="#docs-internal-guid-aca71fac-7fff-6d4a-c944-497f471eda58" id="docs-internal-guid-aca71fac-7fff-6d4a-c944-497f471eda58"></a>

Click the resource name or the More Information button on the resource card and you open the Resource Page for that resource. This shows the following information.

<div align="left" data-with-frame="true"><figure><img src="https://2832631354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4eRiaTyCUWRqgHINBcpH%2Fuploads%2FlrWhw07hBnnQzJmRk9Ls%2FResource%20preview.png?alt=media&amp;token=394535e5-1af1-4140-aa53-f37323e67849" alt="" width="563"><figcaption><p>Resource Preview</p></figcaption></figure></div>

* **Format icon:** This icon displays the format of the resource file.
* **Resource name:**  The name describes the file contents.&#x20;
* **Resource description:** A description of the resource provided by the contributor is displayed here.
* **Download button:** Click to download the file locally and directly to your computer.
* **Export metadata button:** You can export the metadata for each resource in either JSON or CSV.
* **Last modified date:** The date the  data contributor last updated the file.
* **Resource ID:** A unique identifier for the data resource. Click the copy icon to copy this ID, which is useful for API and programmatic access. Find out more about Resource ID in the Build with HDX section.
* **Resource URL:** The full File URL for the resource which you can use to add data to PowerBI (see Power BI section)
* **Resource preview:** View the data in your browser without downloading (available for CSV and some tabular formats) The preview shows column headers, first rows of data and total number of rows and columns. This helps you quickly check whether the data structure meets your needs before downloading.
* **Data dictionary:** View a table of human-readable labels and descriptions for each column or field in the resource.
* **API access section:** Where a dataset is available through Tabular Data this section contains a link to the TDE documentation, a button to get an access token, the Resource ID and an example query.

## Finding out more about datasets

‘Contact the contributor’ lets users send inquiries directly to data contributors. This feature is available on all dataset pages and is located below the organization logo. If you are not already a registered user, you will be prompted to sign up before a message can be sent. Inquiries can be anything from a general question about a dataset to reporting a problem such as a broken link. The HDX team receives a copy of all messages sent through this feature.

### Using the 'Contact the contributor' form

{% stepper %}
{% step %}

#### **Click on the ‘Contact the contributor’ link on any dataset page.**&#x20;

If you're not already logged in, you will be prompted to log in or register before the form appears.

<div align="left" data-with-frame="true"><img src="https://2832631354-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4eRiaTyCUWRqgHINBcpH%2Fuploads%2F8eLugQLZAzkiWGexwSyd%2Funknown.jpeg?alt=media&amp;token=c306560f-61b6-493a-b054-287b7b317320" alt="Contact the contributor form" width="375"></div>
{% endstep %}

{% step %}

#### **Fill out all sections of the form.**&#x20;

* **Your inquiry is regarding :** A dropdown to categorize your message:
  * General question
  * Metadata
  * Problem report
  * Suggested edits
* **Your name and email address:** Where the contributor can reply
* **Comments:** The body of your message.
  {% endstep %}

{% step %}

#### **Click Submit**

Note: It is the responsibility of the contributor to respond to you and the HDX team may not be included in further correspondence.&#x20;

For general questions about HDX itself (rather than specific datasets), email <hdx@un.org>.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.humdata.org/find/understanding-the-hdx-dataset-page.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.