Datasets

Soda Cloud API Dataset Endpoints

Dataset information

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets

This endpoint enables you to gather information about the datasets that in exist in your organization's Soda Cloud account, including information about the Soda Cloud resources with which it is associated, such as data source, incidents, attributes and health status.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 1000, inclusive. The default value is 10.

• page: Supply an integer value. The default value is 0.

• from: Optionally, use this parameter to collect only the information for datasets that have been updated after a particular point in time. Supply an ISO8601 timestamp value. Example: 2023-12-31T10:15:30+01:00

• datasourceName: Optionally, use this parameter to collect only the information for datasets associated with a specific datasource.

• search: Optionally, use this parameter to perform a fuzzy search on the dataset name.

If not specified, the query gathers information for all datasets in the account and sorts the results first by dataset name and then by datasource name in ascending order.

Authorization

Soda only returns the datasets to which the user has View dataset permissions. Soda Cloud Admins have access to all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Query parameters

datasourceNamestringOptional

fromstringOptional

pageinteger · int32Optional

searchstringOptional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets

HTTPcURLJavaScriptPython

GET /api/v1/datasets HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "checks": 1,
      "cloudUrl": "text",
      "dataQualityStatus": "pass",
      "datasource": {
        "label": "text",
        "name": "text",
        "prefix": "text",
        "type": "text",
        "version": "3"
      },
      "healthStatus": 1,
      "id": "text",
      "incidents": 1,
      "label": "text",
      "lastUpdated": "text",
      "name": "text",
      "owners": [
        {
          "type": "user",
          "user": {
            "email": "text",
            "firstName": "text",
            "fullName": "text",
            "lastName": "text",
            "userId": "text"
          },
          "userGroup": {
            "name": "text",
            "userGroupId": "text"
          }
        }
      ],
      "qualifiedName": "text",
      "tags": [
        "text"
      ],
      "timePartition": {
        "partitionColumn": {
          "columnType": "unknown",
          "name": "text"
        },
        "sqlExpression": "text",
        "timePartitionType": "disabled"
      }
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

Get dataset attributes

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/attributes

This endpoint enables you to gather information about the dataset attributes available in your organization's Soda Cloud account. Use the dataset attributes to categorise and organise your datasets.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 1000, inclusive. The default value is 1000.

• page: Supply an integer value. The default value is 0.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Authorization

Any Soda Cloud user in your organization may execute this query.

Tags

Datasets

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/attributes

HTTPcURLJavaScriptPython

GET /api/v1/datasets/attributes HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "allowedValues": [
        {}
      ],
      "description": "text",
      "id": "text",
      "label": "text",
      "name": "text",
      "type": "checkbox"
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

List dataset roles

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/roles

This endpoint enables you to gather information about the dataset roles available in your organization's Soda Cloud account. Use the dataset roles to manage access to individual datasets.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 100, inclusive. The default value is 100.

• page: Supply an integer value. The default value is 0.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Authorization

Any Soda Cloud user in your organization may execute this query.

Tags

Datasets

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/roles

HTTPcURLJavaScriptPython

GET /api/v1/datasets/roles HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "configureDataset": true,
      "createCheckProposals": true,
      "deleteDataset": true,
      "executeContracts": true,
      "id": "text",
      "manageChecks": true,
      "manageContracts": true,
      "manageIncidents": true,
      "managePermissions": true,
      "name": "text",
      "publishContracts": true,
      "viewFailedRows": true,
      "viewProfilingAndSamples": true
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

Update dataset

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}

This endpoint enables you to update an existing dataset properties in your organization's Soda Cloud account.

Authorization

Only users with Configure dataset permission can update dataset properties. Soda Cloud Admins have permission to update all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Body

application/json

labelstringOptional

partitionColumnstringOptionalDeprecated

tagsstring[]Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 1293

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "computeWarehouseOverride": {
    "computeWarehouseConfiguration": {
      "name": "text"
    },
    "enabled": true
  },
  "diagnosticsWarehouse": {
    "failedRowsConfiguration": {
      "enabled": true,
      "failedRowsCollectionStrategy": {
        "maxRowCountOverride": 1,
        "threshold": 1,
        "thresholdCondition": "greaterThan",
        "type": "useDefaultMaxRowCount"
      },
      "maxRowCount": 1,
      "storageStrategy": "fullFailedRows",
      "uniqueKeyColumnNames": [
        "text"
      ]
    },
    "scanAndResultsConfiguration": {
      "enabled": true
    },
    "schema": "text"
  },
  "label": "text",
  "metricMonitoring": {
    "datasetMetricMonitorsConfiguration": [
      {
        "configuration": {
          "exclusionZones": [
            {
              "lowerLimit": 1,
              "singleValue": true,
              "upperLimit": 1
            }
          ],
          "isEnabled": true,
          "isSamplingEnabled": true,
          "sensitivity": 1,
          "thresholdStrategy": {
            "isLowerBoundEnabled": true,
            "isUpperBoundEnabled": true
          },
          "validRange": {
            "max": 1,
            "min": 1
          }
        },
        "metricType": "rowCount"
      }
    ],
    "enabled": true,
    "historicalMetricCollectionScanStartDate": "text",
    "scanSchedule": {
      "cronExpression": "text",
      "timezone": "text"
    }
  },
  "owners": [
    {
      "type": "user",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "profiling": {
    "enabled": true,
    "profilingSamplingStrategy": {
      "numberOfRows": 1,
      "numberOfUnits": 1,
      "unitOfTime": "hours"
    },
    "scanSchedule": {
      "cronExpression": "text",
      "timezone": "text"
    }
  },
  "tags": [
    "text"
  ],
  "timePartition": {
    "partitionColumn": "text",
    "sqlExpression": "text"
  }
}

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "checks": 1,
  "cloudUrl": "text",
  "dataQualityStatus": "pass",
  "datasource": {
    "label": "text",
    "name": "text",
    "prefix": "text",
    "type": "text",
    "version": "3"
  },
  "healthStatus": 1,
  "id": "text",
  "incidents": 1,
  "label": "text",
  "lastUpdated": "text",
  "name": "text",
  "owners": [
    {
      "type": "user",
      "user": {
        "email": "text",
        "firstName": "text",
        "fullName": "text",
        "lastName": "text",
        "userId": "text"
      },
      "userGroup": {
        "name": "text",
        "userGroupId": "text"
      }
    }
  ],
  "qualifiedName": "text",
  "tags": [
    "text"
  ],
  "timePartition": {
    "partitionColumn": {
      "columnType": "unknown",
      "name": "text"
    },
    "sqlExpression": "text",
    "timePartitionType": "disabled"
  }
}

Delete dataset

delete

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}

This endpoint enables you to delete an existing dataset in your organization's Soda Cloud account.

Deletion is not immediate and can take some time to complete, depending on the size of your dataset. You can check the status of the deletion by calling the Get dataset endpoint.

Authorization

Only users with Delete dataset permission can delete a dataset. Soda Cloud Admins have permission to delete any dataset.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

delete

/api/v1/datasets/{datasetId}

HTTPcURLJavaScriptPython

DELETE /api/v1/datasets/{datasetId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "message": "text"
}

Create a column metric monitor

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/columnMetricMonitors

This endpoint allows you to create a new column metric monitor for a specific dataset in your organization's Soda Cloud account.

Authorization

Only users with Manage checks permission can create column metric monitors. Soda Cloud Admins can create column metric monitors for all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Body

application/json

columnNamestringRequired

Responses

201

Created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}/columnMetricMonitors

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId}/columnMetricMonitors HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 411

{
  "columnMetricMonitorConfiguration": {
    "configuration": {
      "groupByColumns": [
        {
          "columnName": "text",
          "excludedValues": [
            "text"
          ]
        }
      ],
      "exclusionZones": [
        {
          "lowerLimit": 1,
          "singleValue": true,
          "upperLimit": 1
        }
      ],
      "isEnabled": true,
      "isSamplingEnabled": true,
      "sensitivity": 1,
      "thresholdStrategy": {
        "isLowerBoundEnabled": true,
        "isUpperBoundEnabled": true
      },
      "validRange": {
        "max": 1,
        "min": 1
      }
    },
    "metricType": "missingPercentage"
  },
  "columnName": "text"
}

{
  "columnMetricMonitor": {
    "checkId": "text",
    "columnName": "text",
    "configuration": {
      "groupByColumns": [
        {
          "columnName": "text",
          "excludedValues": [
            "text"
          ]
        }
      ],
      "exclusionZones": [
        {
          "lowerLimit": 1,
          "singleValue": true,
          "upperLimit": 1
        }
      ],
      "isEnabled": true,
      "isSamplingEnabled": true,
      "sensitivity": 1,
      "thresholdStrategy": {
        "isLowerBoundEnabled": true,
        "isUpperBoundEnabled": true
      },
      "validRange": {
        "max": 1,
        "min": 1
      }
    },
    "metricType": "missingPercentage"
  }
}

Update a column metric monitor

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}

This endpoint allows you to update an existing column metric monitor for a specific dataset in your organization's Soda Cloud account.

Authorization

Only users with Manage checks permission can update column metric monitors. Soda Cloud Admins can update column metric monitors for all datasets. See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

monitorIdstringRequired

Body

application/json

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "configuration": {
    "groupByColumns": [
      {
        "columnName": "text",
        "excludedValues": [
          "text"
        ]
      }
    ],
    "exclusionZones": [
      {
        "lowerLimit": 1,
        "singleValue": true,
        "upperLimit": 1
      }
    ],
    "isEnabled": true,
    "isSamplingEnabled": true,
    "sensitivity": 1,
    "thresholdStrategy": {
      "isLowerBoundEnabled": true,
      "isUpperBoundEnabled": true
    },
    "validRange": {
      "max": 1,
      "min": 1
    }
  }
}

{
  "columnMetricMonitor": {
    "checkId": "text",
    "columnName": "text",
    "configuration": {
      "groupByColumns": [
        {
          "columnName": "text",
          "excludedValues": [
            "text"
          ]
        }
      ],
      "exclusionZones": [
        {
          "lowerLimit": 1,
          "singleValue": true,
          "upperLimit": 1
        }
      ],
      "isEnabled": true,
      "isSamplingEnabled": true,
      "sensitivity": 1,
      "thresholdStrategy": {
        "isLowerBoundEnabled": true,
        "isUpperBoundEnabled": true
      },
      "validRange": {
        "max": 1,
        "min": 1
      }
    },
    "metricType": "missingPercentage"
  }
}

Get dataset compute warehouse configuration

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/computeWarehouse

This endpoint retrieves the compute warehouse configuration for a specific dataset in your organization's Soda Cloud account. When the compute warehouse configuration is enabled, the warehouse in the configuration will be used for compute-heavy tasks like data contract execution, metric monitoring, and profiling.

Authorization

Only users with View dataset permission can retrieve dataset compute warehouse configuration. Soda Cloud Admins have permission to view all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Responses

200

Successful response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/{datasetId}/computeWarehouse

HTTPcURLJavaScriptPython

GET /api/v1/datasets/{datasetId}/computeWarehouse HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "availableWarehouses": [
    {
      "name": "text"
    }
  ],
  "currentWarehouse": {
    "name": "text"
  },
  "datasetWarehouseOverride": {
    "name": "text"
  },
  "defaultWarehouse": {
    "name": "text"
  },
  "enabled": true
}

Create a custom SQL monitor

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/customSqlMonitors

This endpoint allows you to create a new custom SQL monitor for a specific dataset in your organization's Soda Cloud account.

Authorization

Only users with Manage checks permission can create custom SQL monitors. Soda Cloud Admins can create custom SQL monitors for all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Body

application/json

columnNamestringOptional

monitorNamestringRequired

Responses

201

Created

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}/customSqlMonitors

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId}/customSqlMonitors HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 365

{
  "columnName": "text",
  "configuration": {
    "groupByColumnNames": [
      "text"
    ],
    "resultMetric": "text",
    "sqlQuery": "text",
    "exclusionZones": [
      {
        "lowerLimit": 1,
        "singleValue": true,
        "upperLimit": 1
      }
    ],
    "isEnabled": true,
    "isSamplingEnabled": true,
    "sensitivity": 1,
    "thresholdStrategy": {
      "isLowerBoundEnabled": true,
      "isUpperBoundEnabled": true
    },
    "validRange": {
      "max": 1,
      "min": 1
    }
  },
  "monitorName": "text"
}

{
  "customSqlMonitor": {
    "checkId": "text",
    "columnName": "text",
    "configuration": {
      "groupByColumnNames": [
        "text"
      ],
      "resultMetric": "text",
      "sqlQuery": "text",
      "exclusionZones": [
        {
          "lowerLimit": 1,
          "singleValue": true,
          "upperLimit": 1
        }
      ],
      "isEnabled": true,
      "isSamplingEnabled": true,
      "sensitivity": 1,
      "thresholdStrategy": {
        "isLowerBoundEnabled": true,
        "isUpperBoundEnabled": true
      },
      "validRange": {
        "max": 1,
        "min": 1
      }
    },
    "monitorName": "text"
  }
}

Update a custom SQL monitor

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}

This endpoint allows you to update an existing custom SQL monitor for a specific dataset in your organization's Soda Cloud account.

Authorization

Only users with Manage checks permission can update custom SQL monitors. Soda Cloud Admins can update custom SQL monitors for all datasets. See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

100 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

monitorIdstringRequired

Body

application/json

columnNamestringOptional

namestringOptional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "columnName": "text",
  "configuration": {
    "groupByColumnNames": [
      "text"
    ],
    "resultMetric": "text",
    "sqlQuery": "text",
    "exclusionZones": [
      {
        "lowerLimit": 1,
        "singleValue": true,
        "upperLimit": 1
      }
    ],
    "isEnabled": true,
    "isSamplingEnabled": true,
    "sensitivity": 1,
    "thresholdStrategy": {
      "isLowerBoundEnabled": true,
      "isUpperBoundEnabled": true
    },
    "validRange": {
      "max": 1,
      "min": 1
    }
  },
  "name": "text"
}

{
  "customSqlMetricMonitor": {
    "checkId": "text",
    "columnName": "text",
    "configuration": {
      "groupByColumnNames": [
        "text"
      ],
      "resultMetric": "text",
      "sqlQuery": "text",
      "exclusionZones": [
        {
          "lowerLimit": 1,
          "singleValue": true,
          "upperLimit": 1
        }
      ],
      "isEnabled": true,
      "isSamplingEnabled": true,
      "sensitivity": 1,
      "thresholdStrategy": {
        "isLowerBoundEnabled": true,
        "isUpperBoundEnabled": true
      },
      "validRange": {
        "max": 1,
        "min": 1
      }
    },
    "monitorName": "text"
  }
}

Get dataset diagnostics warehouse information

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/diagnosticsWarehouse

This endpoint allows you to retrieve detailed diagnostics warehouse information for a specific dataset in your organization's Soda Cloud account. The diagnostics warehouse collects scan-related data and securely forwards it to the customer's warehouse for storage and analysis.

Authorization

Only users with View dataset permission can view dataset diagnostics warehouse. Soda Cloud Admins have access to diagnostics warehouse information for all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

1000 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/{datasetId}/diagnosticsWarehouse

HTTPcURLJavaScriptPython

GET /api/v1/datasets/{datasetId}/diagnosticsWarehouse HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "failedRowsConfiguration": {
    "enabled": true,
    "failedRowsCollectionStrategy": {
      "maxRowCountOverride": 1,
      "threshold": 1,
      "thresholdCondition": "greaterThan",
      "type": "useDefaultMaxRowCount"
    },
    "maxRowCount": 1,
    "state": "ready",
    "storageStrategy": "fullFailedRows",
    "uniqueKeyColumnNames": [
      "text"
    ]
  },
  "scanAndResultsConfiguration": {
    "enabled": true
  }
}

Get dataset metric monitoring configuration information

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/metricMonitoring

This endpoint allows you to retrieve detailed metric monitoring configuration information for a specific dataset in your organization's Soda Cloud account.

Authorization

Only users with View dataset permission can view dataset metric monitoring configuration. Soda Cloud Admins have access to metric monitoring configuration information for all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

1000 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/{datasetId}/metricMonitoring

HTTPcURLJavaScriptPython

GET /api/v1/datasets/{datasetId}/metricMonitoring HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "columnMetricMonitors": [
    {
      "checkId": "text",
      "columnName": "text",
      "configuration": {
        "groupByColumns": [
          {
            "columnName": "text",
            "excludedValues": [
              "text"
            ]
          }
        ],
        "exclusionZones": [
          {
            "lowerLimit": 1,
            "singleValue": true,
            "upperLimit": 1
          }
        ],
        "isEnabled": true,
        "isSamplingEnabled": true,
        "sensitivity": 1,
        "thresholdStrategy": {
          "isLowerBoundEnabled": true,
          "isUpperBoundEnabled": true
        },
        "validRange": {
          "max": 1,
          "min": 1
        }
      },
      "metricType": "missingPercentage"
    }
  ],
  "customSqlMetricMonitors": [
    {
      "checkId": "text",
      "columnName": "text",
      "configuration": {
        "groupByColumnNames": [
          "text"
        ],
        "resultMetric": "text",
        "sqlQuery": "text",
        "exclusionZones": [
          {
            "lowerLimit": 1,
            "singleValue": true,
            "upperLimit": 1
          }
        ],
        "isEnabled": true,
        "isSamplingEnabled": true,
        "sensitivity": 1,
        "thresholdStrategy": {
          "isLowerBoundEnabled": true,
          "isUpperBoundEnabled": true
        },
        "validRange": {
          "max": 1,
          "min": 1
        }
      },
      "monitorName": "text"
    }
  ],
  "datasetId": "text",
  "datasetMetricMonitorsConfiguration": [
    {
      "configuration": {
        "exclusionZones": [
          {
            "lowerLimit": 1,
            "singleValue": true,
            "upperLimit": 1
          }
        ],
        "isEnabled": true,
        "isSamplingEnabled": true,
        "sensitivity": 1,
        "thresholdStrategy": {
          "isLowerBoundEnabled": true,
          "isUpperBoundEnabled": true
        },
        "validRange": {
          "max": 1,
          "min": 1
        }
      },
      "metricType": "rowCount"
    }
  ],
  "enabled": true,
  "historicalMetricCollectionScanStartDate": "text",
  "scanSchedule": {
    "cronExpression": "text",
    "timezone": "text"
  },
  "timePartition": {
    "partitionColumn": {
      "columnType": "unknown",
      "name": "text"
    },
    "sqlExpression": "text",
    "timePartitionType": "disabled"
  }
}

Get dataset profiling information

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/profiling

This endpoint allows you to retrieve detailed profiling information for a specific dataset in your organization's Soda Cloud account. Profiling information provides insights into the dataset's structure, statistical summaries, and data characteristics.

Authorization

Only users with Access dataset profiling and sampling permission can view dataset profiling. Soda Cloud Admins have access to profiling information for all datasets.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

1000 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/{datasetId}/profiling

HTTPcURLJavaScriptPython

GET /api/v1/datasets/{datasetId}/profiling HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "columnCount": 1,
  "columns": [
    {
      "id": "text",
      "metrics": {
        "average": 1,
        "averageLength": 1,
        "distinctCount": 1,
        "extremeValues": {
          "maximum": [
            {}
          ],
          "minimum": [
            {}
          ]
        },
        "frequentValues": [
          {
            "count": 1,
            "value": {}
          }
        ],
        "histogram": [
          {
            "count": 1,
            "lowerBound": 1,
            "upperBound": 1
          }
        ],
        "maximum": {},
        "maximumLength": 1,
        "maximumTimestamp": "text",
        "median": 1,
        "minimum": {},
        "minimumLength": 1,
        "minimumTimestamp": "text",
        "missingCount": 1,
        "standardDeviation": 1,
        "sum": 1,
        "variance": 1
      },
      "name": "text",
      "type": "text"
    }
  ],
  "datasetId": "text",
  "enabled": true,
  "profilingTime": "text",
  "rowCount": 1,
  "samplingStrategyConfiguration": {
    "numberOfRows": 1,
    "numberOfUnits": 1,
    "unitOfTime": "hours"
  },
  "scanSchedule": {
    "cronExpression": "text",
    "timezone": "text"
  },
  "timePartition": {
    "partitionColumn": {
      "columnType": "unknown",
      "name": "text"
    },
    "sqlExpression": "text",
    "timePartitionType": "disabled"
  }
}

List dataset responsibilities

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/responsibilities

This endpoint enables you to gather information about the user and user groups permissions assigned to a dataset, and their associated roles in your organization's Soda Cloud account.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 1 and 100, inclusive. The default value is 100.

• page: Supply an integer value. The default value is 0.

Authorization

Soda only returns the dataset responsibilities to which the user has View dataset permissions. Soda Cloud Admins have access to all dataset responsibilities.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Query parameters

pageinteger · int32Optional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

/api/v1/datasets/{datasetId}/responsibilities

HTTPcURLJavaScriptPython

GET /api/v1/datasets/{datasetId}/responsibilities HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "managed": true,
      "role": {
        "configureDataset": true,
        "createCheckProposals": true,
        "deleteDataset": true,
        "executeContracts": true,
        "id": "text",
        "manageChecks": true,
        "manageContracts": true,
        "manageIncidents": true,
        "managePermissions": true,
        "name": "text",
        "publishContracts": true,
        "viewFailedRows": true,
        "viewProfilingAndSamples": true
      },
      "type": "user",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

Update dataset responsibilities

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/datasets/{datasetId}/responsibilities

This endpoint enables you to update the user and user groups permissions and their associated roles for a dataset in your organization's Soda Cloud account.

Note: This API fully replaces the existing responsibilities. The entire list of responsibilities must be provided in the request, including both new and existing entries, as any omissions will result in their removal.

Authorization

Only users with Manage dataset responsibilities permission can update dataset responsibilities. Soda Cloud Admins have permission to update all datasets responsibilities.**See Manage dataset roles for more information.**The Response of this call, when successful, is 201 and contains header Location which identify the URL where the responsibilities will eventually become available.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Datasets

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKey

AuthorizationstringRequired

Path parameters

datasetIdstringRequired

Body

application/json

Responses

201

Created

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/api/v1/datasets/{datasetId}/responsibilities

HTTPcURLJavaScriptPython

POST /api/v1/datasets/{datasetId}/responsibilities HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "responsibilities": [
    {
      "roleId": "text",
      "type": "user",
      "userGroupId": "text",
      "userId": "text"
    }
  ]
}

No content