Datasets

General

When you run a rule, a dataset is generated with the result of the execution. This new dataset can be a subsets (for example using operations like limit or include/exclude) or full datasets.

The datasets can be downloaded to local folder (JSON or CSV) or can be loaded into one of the available sinks.

Load

To load a dataset into a sink, the sink must be added to the model. You can find more information about how to add a sink to the model in the Sinks page.

Once executed, a job will be created where you can see the progress of the load.

UI Options

The Datasets page provides several interaction options for each dataset in the table:

Share Functionality

The Share button allows you to create public URLs to share your datasets. When you click the Share button:

1. If you have only one API key in your project, it automatically creates a shareable endpoint
2. If you have multiple API keys, you'll be prompted to select which one to use

Share URL Structure

Once shared, datasets are accessible via URLs with the following structure:

[protocol]//[hostname]/api/[organization]/[project]/model/[model-seq]/dataset/[dataset-seq]

For example:

https://yourserver/api/acme-corp/sales-data/model/1/dataset/42

URL Parameters

You can customize the shared URL with additional parameters:

Example URLs with parameters:

• https://yourserver/api/acme-corp/sales-data/model/1/dataset/42?format=json-zip
• https://yourserver/api/acme-corp/sales-data/model/1/dataset/42?format=csv-zip
• https://yourserver/api/acme-corp/sales-data/model/1/dataset/42?format=sql

Sharing UI Details

When you click the Share button, the row expands to show:

1. API Endpoint: The full URL to access your dataset
2. Format Selector: Dropdown to choose the format (JSON ZIP, CSV ZIP, SQL)
3. Copy Button: Copy the URL with selected format to clipboard
4. Call Counter: Shows how many times the endpoint has been accessed
5. Delete Option: Remove the API endpoint if no longer needed

ASCII Representation of Dataset Table

┌─────────────────────────────────────────────────────────────────────────────────────┐
│ Dataset Name         Rule     Last Updated   Created By   Size       Actions        │
├─────────────────────────────────────────────────────────────────────────────────────┤
│ customers_2023       filter   2 hours ago    John Doe     2.4 MB     Download Share Delete │
│ products_filtered    select   1 day ago      Jane Smith   15.7 MB    Download Share Delete │
└─────────────────────────────────────────────────────────────────────────────────────┘

When you click the Share button for a dataset, the row expands:

┌─────────────────────────────────────────────────────────────────────────────────────┐
│ Dataset Name         Rule     Last Updated   Created By   Size       Actions        │
├─────────────────────────────────────────────────────────────────────────────────────┤
│ customers_2023       filter   2 hours ago    John Doe     2.4 MB     Download Share Delete │
├─────────────────────────────────────────────────────────────────────────────────────┤
│ ┌── GET ──┐ https://yourserver/api/org/proj/model/1/dataset/42           [Copy]     │
│ │  # calls │                                                              [Delete] │
│ └─────────┘  ?format= [json-zip ▼]                                              │
└─────────────────────────────────────────────────────────────────────────────────────┘

This expanded view shows the shareable URL, allows you to select different formats, and provides options to copy the URL or delete the endpoint.