Soda Datasets API
The Datasets surface of the Soda Cloud v4 API — 24 operation(s) across 17 path(s).
Operations 24
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which datasets does my Soda Cloud account monitor, and what is their health?”
“Can I list only the datasets from one data source?”
Tell an agent
List all my datasets.
Show datasets in data source {datasourceName}.
GET
/api/v1/datasets/byDatasetQualifiedName/{datasetQualifiedName}
Get a dataset by qualified name · Get dataset by qualified name
#
Ask an LLM
“Can I look up a dataset by its fully qualified name rather than its ID?”
“What dataset matches a given contract identifier?”
Tell an agent
Get the dataset with qualified name {datasetQualifiedName}.
Look up dataset {datasetQualifiedName} by its contract identifier.
Ask an LLM
“What dataset-level roles are available for granting access?”
“Which permission sets exist for individual datasets?”
Tell an agent
List the dataset roles in my organization.
Show page {page} of dataset roles.
Ask an LLM
“How do I create a dataset role that can manage checks but not delete datasets?”
“Can a custom dataset role allow viewing failed rows?”
Tell an agent
Create a dataset role named {name}.
Create dataset role {name} with manage-checks set to {manageChecks} and view-failed-rows {viewFailedRows}.
Ask an LLM
“Can I change the permissions of an existing dataset role?”
“How do I rename a custom dataset role?”
Tell an agent
Rename dataset role {roleId} to {name}.
Update dataset role {roleId} ({name}) so manage-incidents is {manageIncidents}.
Ask an LLM
“How do I remove a custom dataset role?”
“Can I delete a dataset permission role I created?”
Tell an agent destructive · confirm first
Delete dataset role {roleId}.
Remove the custom dataset role {roleId}.
Ask an LLM
“What are the details of one dataset in Soda Cloud?”
“Can I fetch a single dataset using its ID?”
Tell an agent
Get dataset {datasetId}.
Show the details of dataset {datasetId}.
Ask an LLM
“How do I change a dataset's owners, label or tags?”
“Can I turn profiling on or off for a dataset?”
Tell an agent
Set the owners of dataset {datasetId} to {owners}.
Relabel dataset {datasetId} as {label} and tag it {tags}.
Ask an LLM
“How do I delete a dataset from Soda Cloud?”
“Why does dataset deletion take a while to complete?”
Tell an agent destructive · confirm first
Delete dataset {datasetId}.
Remove dataset {datasetId} from my account.
POST
/api/v1/datasets/{datasetId}/columnAttributes
Set attribute values on dataset columns · Set column attribute values in bulk
#
Ask an LLM
“Can I tag many columns of a dataset with attribute values in one call?”
“Does setting one column attribute overwrite the column's other attributes?”
Tell an agent
Set these column attribute values on dataset {datasetId}: {columnAttributes}.
Bulk-update column attributes of dataset {datasetId} with {columnAttributes}.
POST
/api/v1/datasets/{datasetId}/columnMetricMonitors
Create a column metric monitor · Create a column metric monitor
#
Ask an LLM
“How do I start monitoring a metric on a specific column?”
“Can I add a metric monitor to one column of a dataset?”
Tell an agent
Add a metric monitor on column {columnName} of dataset {datasetId} with configuration {columnMetricMonitorConfiguration}.
Create a column metric monitor for {columnName} in dataset {datasetId} using {columnMetricMonitorConfiguration}.
POST
/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}
Update a column metric monitor · Update a column metric monitor
#
Ask an LLM
“Can I change the configuration of an existing column metric monitor?”
“What permission is needed to edit a column metric monitor?”
Tell an agent
Update column metric monitor {monitorId} on dataset {datasetId} with {configuration}.
Reconfigure column monitor {monitorId} of dataset {datasetId} to {configuration}.
DELETE
/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}
Delete a column metric monitor · Delete a column metric monitor
#
Ask an LLM
“How do I stop monitoring a metric on a column?”
“Can I remove a column metric monitor from a dataset?”
Tell an agent destructive · confirm first
Delete column metric monitor {monitorId} from dataset {datasetId}.
Remove column monitor {monitorId} on dataset {datasetId}.
GET
/api/v1/datasets/{datasetId}/columns
List a dataset's columns and attributes · List the active columns of a dataset with their attribute values
#
Ask an LLM
“What columns does a dataset have, and which attributes are set on each?”
“Which columns of a dataset have no attribute values yet?”
Tell an agent
List the active columns of dataset {datasetId} with their attribute values.
Show page {page} of columns for dataset {datasetId}.
GET
/api/v1/datasets/{datasetId}/computeWarehouse
Get a dataset's compute warehouse config · Get dataset compute warehouse configuration
#
Ask an LLM
“Which warehouse runs compute-heavy tasks for a dataset?”
“Is a compute warehouse override enabled on this dataset?”
Tell an agent
Show the compute warehouse configuration of dataset {datasetId}.
Check whether dataset {datasetId} uses a compute warehouse override.
POST
/api/v1/datasets/{datasetId}/customSqlMonitors
Create a custom SQL monitor · Create a custom SQL monitor
#
Ask an LLM
“Can I monitor a dataset with my own SQL metric query?”
“How do I attach a custom SQL monitor to a column?”
Tell an agent
Create custom SQL monitor {monitorName} on dataset {datasetId} with configuration {configuration}.
Add SQL monitor {monitorName} for column {columnName} of dataset {datasetId} using {configuration}.
POST
/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}
Update a custom SQL monitor · Update a custom SQL monitor
#
Ask an LLM
“Can I edit the SQL or name of an existing custom SQL monitor?”
“Is it possible to move a custom SQL monitor to another column?”
Tell an agent
Rename custom SQL monitor {monitorId} on dataset {datasetId} to {name}.
Change the configuration of SQL monitor {monitorId} in dataset {datasetId} to {configuration}.
DELETE
/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}
Delete a custom SQL monitor · Delete a custom SQL monitor
#
Ask an LLM
“How do I remove a custom SQL monitor from a dataset?”
“Who is allowed to delete custom SQL monitors?”
Tell an agent destructive · confirm first
Delete custom SQL monitor {monitorId} from dataset {datasetId}.
Remove SQL monitor {monitorId} on dataset {datasetId}.
GET
/api/v1/datasets/{datasetId}/diagnosticsWarehouse
Get a dataset's diagnostics warehouse info · Get dataset diagnostics warehouse information
#
Ask an LLM
“Where are scan results and failed rows for a dataset being stored in my warehouse?”
“What diagnostics warehouse settings apply to this particular dataset?”
Tell an agent
Show diagnostics warehouse information for dataset {datasetId}.
Get where dataset {datasetId} forwards its scan diagnostics.
GET
/api/v1/datasets/{datasetId}/metricMonitoring
Get a dataset's metric monitoring config · Get dataset metric monitoring configuration information
#
Ask an LLM
“Is metric monitoring enabled on this dataset, and how is it configured?”
“What anomaly monitoring settings does a dataset have?”
Tell an agent
Show the metric monitoring configuration of dataset {datasetId}.
Check whether metric monitoring is on for dataset {datasetId}.
POST
/api/v1/datasets/{datasetId}/metricMonitoring/historicalMetricCollection
Backfill historical metrics for a dataset · Run historical metric collection for a dataset
#
Ask an LLM
“Can I backfill historical metrics so monitoring has past data to compare?”
“What must be configured before running historical metric collection?”
Tell an agent
Run historical metric collection for dataset {datasetId}.
Backfill past metrics on dataset {datasetId}.
GET
/api/v1/datasets/{datasetId}/profiling
Get dataset profiling results · Get dataset profiling information
#
Ask an LLM
“What do the statistical profiles of a dataset's columns look like?”
“Can I see the profiling summary for a table?”
Tell an agent
Show profiling information for dataset {datasetId}.
Get column statistics from the profile of dataset {datasetId}.
GET
/api/v1/datasets/{datasetId}/responsibilities
List who has access to a dataset · List dataset responsibilities
#
Ask an LLM
“Which users and groups have roles on a dataset?”
“Who is responsible for a given dataset?”
Tell an agent
List responsibilities on dataset {datasetId}.
Show which users and groups hold roles on dataset {datasetId}.
POST
/api/v1/datasets/{datasetId}/responsibilities
Replace dataset access assignments · Update dataset responsibilities
#
Ask an LLM
“How do I grant a user group a role on a dataset?”
“Does updating dataset responsibilities replace the whole existing list?”
Tell an agent
Set the responsibilities on dataset {datasetId} to {responsibilities}.
Replace who can access dataset {datasetId} with {responsibilities}.