API: Datasets
Warehouse datasets: import, refresh, schedule, and history. All endpoints require authentication unless noted. 9 endpoints.
GET /api/datasets
Section titled “GET /api/datasets”List Warehouse datasets (with freshness)
Responses: 200 · 400 · 401
POST /api/datasets
Section titled “POST /api/datasets”Import a table or saved query into the Warehouse as a managed dataset
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | yes | |
source |
object | yes | |
schedule |
object | no |
Responses: 201 · 400 · 401 · 404 · 409 · 422 · 502 · 503
GET /api/datasets/{id}
Section titled “GET /api/datasets/{id}”Get a dataset (schema from the live Warehouse DESCRIBE when reachable)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 200 · 400 · 401 · 404
DELETE /api/datasets/{id}
Section titled “DELETE /api/datasets/{id}”Delete a dataset (refused with the dependents list while anything references it)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 204 — No content · 401 · 404 · 409
POST /api/datasets/{id}/autowire
Section titled “POST /api/datasets/{id}/autowire”Create (or refresh) the model + starter dashboard backed by this dataset
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 200 · 400 · 401 · 404 · 409 · 422
GET /api/datasets/{id}/lineage
Section titled “GET /api/datasets/{id}/lineage”Column lineage around this dataset (feeding pipelines + consuming BI assets)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 200 · 400 · 401 · 404
POST /api/datasets/{id}/refresh
Section titled “POST /api/datasets/{id}/refresh”Re-import the dataset and swap atomically (EXCHANGE TABLES — never in-place)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Responses: 200 · 400 · 401 · 404 · 409 · 422 · 502 · 503
GET /api/datasets/{id}/refreshes
Section titled “GET /api/datasets/{id}/refreshes”Refresh history (pipeline runs of the linked system pipeline; scheduled refreshes record here)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit |
integer | no | Maximum number of items to return |
offset |
integer | no | Number of items to skip |
Responses: 200 · 400 · 401
PUT /api/datasets/{id}/schedule
Section titled “PUT /api/datasets/{id}/schedule”Set or clear the refresh schedule (enabled schedules fire via the schedule poller)
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
string | yes |
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
cron |
string | no | |
timezone |
string | no | |
enabled |
boolean | no |
Responses: 200 · 400 · 401 · 404 · 422