Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
UN Data Connector
Overview
The UNData Connector facilitates seamless access to a wide range of datasets, including world development indicators and financial accounts, for applications such as data analytics, economic research, or visualization tools. This connector acts as a proxy to streamline data retrieval, supporting actions for dataset enumeration and specific data queries.
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 UNData 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).
Detailed Integration Documentation
Dataflows Retrieval
| Action | getDatasets |
| Purpose | Retrieves a comprehensive list of all dataflows (datasets) available in the UNData API. This serves as the primary entry point for exploring available data. |
| Parameters |
|
| Configuration | Ensure the connector is configured with the correct base URL via CONNECTOR_ENV_UNDATA_BASE_URL (default: https://data.un.org). The port is configurable via CONNECTOR_ENV_PORT (default: 8081). |
| Output |
|
| Workflow Example | Configure the connector with the appropriate base URL (e.g., https://data.un.org). Execute the getDatasets action to fetch a list of dataflows. Process the response to 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. |
| Parameters |
|
| Configuration | Ensure the connector is configured with the correct base URL via CONNECTOR_ENV_UNDATA_BASE_URL. |
| Output |
|
| Workflow Example | Execute the getWorldDevIndicators action with optional parameters (e.g., indicator=GDP). Process the response to 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. |
| Parameters |
|
| Configuration | Ensure the connector is configured with the correct base URL. |
| Output |
|
| Workflow Example | Execute the getQuarterlyFinancialAccounts action with optional parameters (e.g., country=USA). Process the response 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 financial trend analysis. |
| Parameters |
|
| Configuration | Ensure the connector is configured with the correct base URL. |
| Output |
|
| Workflow Example | Execute the getAnnualFinancialAccounts action with optional parameters (e.g., country=USA). Process the response for trend analysis or reporting. |
Workflow Creation with the Connector
Example Workflow: Exploring and Analyzing UNData
| Retrieve Dataflows | Use the getDatasets action to fetch a list of available dataflows. Identify target datasets (e.g., DF_UNData_UNFCC, NASEC_IDCFINA_Q). |
| Query Specific Data | Execute the getWorldDevIndicators action with parameters (e.g., indicator=GDP&country=USA) to fetch development metrics. Use getQuarterlyFinancialAccounts or getAnnualFinancialAccounts with parameters (e.g., country=USA) to fetch financial data. |
| Analyze or Visualize | Process the retrieved data for analysis (e.g., economic trends) or visualization (e.g., charts of GDP growth). |
This workflow enables applications to perform targeted discovery, metadata enrichment, and reliable delivery of scholarly records, improving catalog quality, reporting accuracy, and integration efficiency.
Pricing
iSolution logo - white - transparent 250 px