KSA Open Data Portal Connector
The KSA Open Data Platform Connector enables seamless integration with the Saudi Open Data Platform, providing access to dataset and organization data for analytics, visualization, and reporting. It acts as a proxy for dataset-metadata queries, resource access, and organization-details retrieval.
Integration Overview
This document outlines each integration action point, its purpose, configuration, and workflow support using the KSA Open Data Platform Connector. Datasets and organizations can be addressed by ID or by Arabic/English name.
- Dataset Metadata Retrieval. Retrieves metadata for a dataset — titles, descriptions, provider details, and categories.
- Dataset Resources Retrieval. Fetches resources (e.g. downloadable files) associated with a dataset.
- Organization Details Retrieval. Retrieves metadata for an organization — name, description, and associated datasets.
Detailed Integration Documentation
Dataset Metadata Retrieval
| Endpoint | /datasets |
|---|---|
| Purpose | Retrieves comprehensive metadata for a specific dataset — titles, descriptions, provider information, categories, and timestamps. |
| Configuration | Configure the connector with the appropriate environment variables for authentication and connectivity. |
| Parameters | Required: version (integer, e.g. -1); dataset (string) — the dataset ID (e.g. 565f4740-…), Arabic name (إحصاءات السكان 2025), or English name (Population Statistics 2025). |
| Output | Successful: JSON with transactionId, id, titleEn/Ar, descriptionEn/Ar, providerNameEn/Ar, organizationId, updateFrequency, language, timePeriod, resourcesCount, categories, tags, createdAt, updatedAt. Failure: invalid dataset ID or missing parameters. |
| Workflow example | Identify the dataset ID or name, then execute with version=-1 and dataset=Population Statistics 2025 to extract metadata. |
Dataset Resources Retrieval
| Endpoint | /datasets/resources |
|---|---|
| Purpose | Retrieves a list of resources (e.g. downloadable files) associated with a dataset — for analysis or processing. |
| Configuration | Configure the connector with the appropriate environment variables for authentication and connectivity. |
| Parameters | Required: version (integer, e.g. -1); dataset (string) — ID, Arabic name, or English name. |
| Output | Successful: JSON with transactionId, datasetId, and a resources array (id, name, descriptionEn/Ar, format, columns, downloadUrl, createdAt, updatedAt). Failure: invalid dataset ID or no associated resources. |
| Workflow example | Select a dataset, execute with version=-1 and the dataset ID/name, then extract downloadUrl for the desired resource (e.g. a CSV). |
Organization Details Retrieval
| Endpoint | /organizations |
|---|---|
| Purpose | Retrieves detailed metadata for an organization publishing datasets — name, description, and associated datasets. |
| Configuration | Configure the connector with the appropriate environment variables for authentication and connectivity. |
| Parameters | Required: version (integer, e.g. -1); organization (string) — the organization ID (e.g. org-1234-…), Arabic name (وزارة الصحة), or English name (Ministry of Health). |
| Output | Successful: JSON with transactionId, id, nameEn/Ar, descriptionEn/Ar, websiteUrl, addressEn/Ar, typeEn/Ar, rating, and a datasets array. Failure: 404 if the organization ID/name is incorrect or does not exist. |
| Workflow example | Identify the organization ID or name, then execute with version=-1 and organization=Ministry of Health to display details or associated dataset IDs. |
Example Workflow: Accessing & Downloading Dataset Resources
| Retrieve metadata | Use Dataset Metadata Retrieval with version=-1 and a dataset name/ID; confirm relevance via titleEn or categories. |
|---|---|
| Retrieve resources | Use Dataset Resources Retrieval, then parse the resources array to find the desired format (e.g. CSV). |
| Download | Extract the downloadUrl and download the file for analysis or integration. |
| Organization context | If needed, use Organization Details Retrieval with the organizationId from the metadata. |
Use Case
A data analytics firm uses the KSA Open Data Platform Connector with GCP to access Saudi Open Data Platform datasets for economic and demographic analysis. Using /datasets and /datasets/resources, the firm retrieves metadata and resources like Population Statistics 2025 in CSV. Data is ingested into BigQuery for advanced querying, while /organizations fetches provider details stored in Cloud Storage — enabling trend analysis, reporting, and visualization in Google Data Studio for strategic planning.
For technical support, contact custom-connectors-support@isolutions.sa.