Custom Connector
UN Data Connector
Global
The UNData Connector facilitates seamless access to a wide range of datasets, including world development indicators and financial accounts, for data analytics, economic research, and visualization. It acts as a proxy to streamline data retrieval, supporting dataset enumeration and specific data queries.
Overview
Integration Overview
This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the UNData API Connector.
- getDatasets. Retrieves a list of all available dataflows (datasets) from the UNData API.
- getWorldDevIndicators. Retrieves data from the World Development Indicators dataset (DF_UNData_UNFCC).
- getQuarterlyFinancialAccounts. Retrieves quarterly financial accounts data (NASEC_IDCFINA_Q).
- getAnnualFinancialAccounts. Retrieves annual financial accounts data (NASEC_IDCFINA_A).
Documentation
Detailed Integration Documentation
Dataflows Retrieval
| Action | getDatasets |
|---|---|
| Purpose | Retrieves a comprehensive list of all dataflows (datasets) available in the UNData API — the primary entry point for exploring available data. |
| Configuration | Configure the base URL via CONNECTOR_ENV_UNDATA_BASE_URL (default https://data.un.org). The port is configurable via CONNECTOR_ENV_PORT (default 8081). |
| Parameters | Required: None. Optional: query parameters supported by the UNData API, passed through (e.g. agency, version). Headers such as Content-Type and Accept (default application/json). |
| Output | Successful: JSON object with the list of dataflows. Failure: JSON error message with the upstream status code. |
| Workflow example | Execute getDatasets to fetch dataflows, then identify datasets (e.g. DF_UNData_UNFCC) for further queries. |
World Development Indicators
| Action | getWorldDevIndicators |
|---|---|
| Purpose | Retrieves data from the UNData World Development Indicators dataset (DF_UNData_UNFCC), enabling access to global development metrics. |
| Configuration | Configure the base URL via CONNECTOR_ENV_UNDATA_BASE_URL (default https://data.un.org). The port is configurable via CONNECTOR_ENV_PORT (default 8081). |
| Parameters | Required: None. Optional: query parameters for the DF_UNData_UNFCC dataset, passed through (e.g. indicator, country). Custom headers. |
| Output | Successful: JSON object with the World Development Indicators data. Failure: JSON error with status code. |
| Workflow example | Execute getWorldDevIndicators with indicator=GDP, then analyze or visualize development metrics. |
Quarterly Financial Accounts
| Action | getQuarterlyFinancialAccounts |
|---|---|
| Purpose | Retrieves quarterly financial accounts data from the NASEC_IDCFINA_Q dataset, suitable for financial analysis and reporting. |
| Configuration | Configure the base URL via CONNECTOR_ENV_UNDATA_BASE_URL (default https://data.un.org). The port is configurable via CONNECTOR_ENV_PORT (default 8081). |
| Parameters | Required: None. Optional: query parameters for NASEC_IDCFINA_Q, passed through (e.g. country, sector). Custom headers. |
| Output | Successful: JSON object with quarterly financial accounts data. Failure: JSON error with status code. |
| Workflow example | Execute getQuarterlyFinancialAccounts with country=USA for financial analysis or reporting. |
Annual Financial Accounts
| Action | getAnnualFinancialAccounts |
|---|---|
| Purpose | Retrieves annual financial accounts data from the NASEC_IDCFINA_A dataset, ideal for long-term trend analysis. |
| Configuration | Configure the base URL via CONNECTOR_ENV_UNDATA_BASE_URL (default https://data.un.org). The port is configurable via CONNECTOR_ENV_PORT (default 8081). |
| Parameters | Required: None. Optional: query parameters for NASEC_IDCFINA_A, passed through (e.g. country, sector). Custom headers. |
| Output | Successful: JSON object with annual financial accounts data. Failure: JSON error with status code. |
| Workflow example | Execute getAnnualFinancialAccounts with country=USA for trend analysis or reporting. |
Example Workflow: Exploring & Analyzing UNData
| Retrieve dataflows | Use getDatasets to fetch available dataflows and identify targets (e.g. DF_UNData_UNFCC, NASEC_IDCFINA_Q). |
|---|---|
| Query specific data | Execute getWorldDevIndicators (e.g. indicator=GDP&country=USA), or getQuarterlyFinancialAccounts / getAnnualFinancialAccounts (e.g. country=USA). |
| Analyze or visualize | Process the retrieved data for analysis (economic trends) or visualization (GDP-growth charts). |
Support
For technical support, contact custom-connectors-support@isolutions.sa.