Dataset Using External Sources
This guide explains how to create a dataset in AIV using external data sources. External datasets are populated by LiveCompare actions and store results as External Data Sources, providing access to live data from APIs, statistics departments, third-party databases, and similar sources.
What is an External Dataset?
External datasets pull data from APIs or external services. Results are stored as External Data Sources, and users can work with live data. Common use cases include data from statistics departments, third-party market research databases, official press releases, and public APIs.
Prerequisites
Before you begin:
- Have an API endpoint that returns data in CSV or JSON format.
- Ensure the API URL is accessible from your AIV environment.
- Supported output types: CSV and JSON.
Request Types
| Type | Use Case |
|---|---|
| GET | Retrieve existing data from an entity set. |
| POST | Create a new object in the system and obtain information about it. |
POST request type will be available in a subsequent release.
Steps to Create an External Dataset
Step 1: Open External Services
- Navigate to External Services in the application.
Step 2: Configure the Dataset
In Create Dataset, enter:
| Field | Value |
|---|---|
| Name | External (or your preferred name) |
| Datasource | External Services |
| Details | GET |
| Link | Your API URL (e.g., https://api.covid19india.org/csv/latest/states.csv) |
| Separator | , (for CSV) |
| Output type | CSV or JSON, as appropriate |
For more API sources, see data.gov.
Step 3: Preview and Submit
- Click Preview to verify the data structure.
- Click Submit to create the dataset.
Step 4: Verify the Dataset
The External Dataset appears in the Dataset list. Double-click it to view and use the data.
Step 5: Use the Dataset in a Dashboard (Optional)
- Go to the Dashboard tab and create a dashboard, or open an existing one.
- From the left menu, select the Table Widget icon.
- In the Edit menu:
- Select Dataset: External.ds
- Select the fields you want to display in the Dataset column.
- Click Save and Publish.
Related Guides
Explore other ways to create datasets in AIV:
| Data Source | Guide |
|---|---|
| Drag & drop | Create Dataset |
| Excel | Dataset using Excel |
| CSV | Dataset using CSV |
| JSON | Dataset using JSON |
| Parquet | Dataset using Parquet |
| NoSQL | Dataset using NoSQL |
| Flat files | Dataset using Flat files |
| Google BigQuery | Dataset using Google BigQuery |
| Google Sheet | Dataset using Google Sheet |
| Stored Procedure | Dataset using Stored Procedure |
| View | Dataset using View |
JSON file type and POST request type will be available in subsequent releases.