v1

latestOpenAPI 3.1.02026-07-23103397.3 KB
Metadata

Get information about the sources of the data in HDX HAPI

Get information about the <a href="https://data.humdata.org/dataset">HDX Datasets</a> that are used as data sources for HDX HAPI. Datasets contain one or more resources, which are the sources of the data found in HDX HAPI.

get/api/v2/metadata/dataset

Query parameters

app_identifierstring nullable required

base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.

base64 encoded application name and email, as in base64("app_name:email"). This value can also be passed in the X-HDX-HAPI-APP-IDENTIFIER header. See the encoded_app_identifier endpoint.

dataset_hdx_idstring nullable

Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_id] will load the dataset page on HDX.

Filter the response by the dataset ID (dataset_hdx_id), which is a unique and fixed identifier of a Dataset on HDX. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_id] will load the dataset page on HDX.

dataset_hdx_stubstring nullable

Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_stub] will load the dataset page on HDX.

Filter the response by the URL-safe name (dataset_hdx_stub) of the dataset as displayed on HDX. This name is unique but can change. A URL in the pattern of https://data.humdata.org/dataset/[dataset_hdx_stub] will load the dataset page on HDX.

dataset_hdx_titlestring nullable

Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change.

Filter the response by the title of the dataset as it appears in the HDX interface. This name is not unique and can change.

hdx_provider_stubstring nullable

Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of https://data.humdata.org/organization/[hdx_provider_stub] will load the provider's page on HDX.

Filter the response by the URL-safe name of the provider (organization) of the dataset on HDX. A URL in the pattern of https://data.humdata.org/organization/[hdx_provider_stub] will load the provider's page on HDX.

hdx_provider_namestring nullable

Filter the response by the display name of the provider (organization) of the dataset on HDX.

Filter the response by the display name of the provider (organization) of the dataset on HDX.

output_format'csv' | 'json'
limitinteger

Maximum number of records to return. The system will not return more than 10,000 records.

Maximum number of records to return. The system will not return more than 10,000 records.

offsetinteger

Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.

Number of records to skip in the response. Use in conjunction with the limit parameter to paginate.

Response

Successful Response