# Datasets Soda Cloud API Dataset Endpoints ## Dataset information > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 30 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetsContentDTO"}},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"required":["content","first","last","number","size","totalElements","totalPages"]},"DatasetsContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checks":{"type":"number"},"cloudUrl":{"type":"string"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO"},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"healthStatus":{"type":"integer","format":"int32"},"id":{"type":"string"},"incidents":{"type":"number"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}},"required":["checks","cloudUrl","healthStatus","id","incidents","name"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataQualityStatusDTO":{"type":"string","enum":["pass","warn","fail"]},"DatasourcePropertiesDTO":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"type":{"type":"string"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}}},"ModelVersionDTO":{"type":"string","enum":["3","4"]},"DatasetOwnerDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["name","userGroupId"]},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets":{"get":{"description":"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.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `size`: Supply an integer value between 10 and 1000, inclusive. The default value is 10.\n\n- `page`: Supply an integer value. The default value is 0.\n\n- `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`\n\n- `datasourceName`: Optionally, use this parameter to collect only the information for datasets associated with a specific datasource.\n\n- `search`: Optionally, use this parameter to perform a fuzzy search on the dataset name.\n\nIf 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.\n\n## Authorization\n\nSoda only returns the datasets to which the user has **View dataset** permissions. Soda Cloud Admins have access to all datasets.**See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n30 requests/60 seconds","operationId":"GET/api/v1/datasets","parameters":[{"in":"query","name":"datasourceName","schema":{"type":"string"}},{"in":"query","name":"from","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"page","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"search","schema":{"type":"string"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetsResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Dataset information","tags":["Datasets"]}}}} ``` ## Get dataset by qualified name > This endpoint enables you to retrieve a single dataset by its qualified name (contractIdentifier) from your organization's Soda Cloud account.\ > \ > \## Authorization\ > \ > Only users with \*\*View dataset\*\* permission can view a dataset. Soda Cloud Admins have permission to view any dataset. \*\*See \[Manage dataset roles]\() for more information.\*\*\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 1000 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"DatasetsContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checks":{"type":"number"},"cloudUrl":{"type":"string"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO"},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"healthStatus":{"type":"integer","format":"int32"},"id":{"type":"string"},"incidents":{"type":"number"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}},"required":["checks","cloudUrl","healthStatus","id","incidents","name"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataQualityStatusDTO":{"type":"string","enum":["pass","warn","fail"]},"DatasourcePropertiesDTO":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"type":{"type":"string"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}}},"ModelVersionDTO":{"type":"string","enum":["3","4"]},"DatasetOwnerDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["name","userGroupId"]},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/byDatasetQualifiedName/{datasetQualifiedName}":{"get":{"description":"This endpoint enables you to retrieve a single dataset by its qualified name (contractIdentifier) from your organization's Soda Cloud account.\n\n## Authorization\n\nOnly users with **View dataset** permission can view a dataset. Soda Cloud Admins have permission to view any dataset. **See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/datasets/byDatasetQualifiedName/{datasetQualifiedName}","parameters":[{"in":"path","name":"datasetQualifiedName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DatasetsContentDTO"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset by qualified name","tags":["Datasets"]}}}} ``` ## List dataset 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Authorization\ > \ > Any Soda Cloud user in your organization may execute this query.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 60 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetRolesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"}},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"required":["content","first","last","number","size","totalElements","totalPages"]},"DatasetRoleContentDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"executeContracts":{"type":"boolean","deprecated":true},"id":{"type":"string"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"publishContracts":{"type":"boolean","deprecated":true},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["id","name"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/roles":{"get":{"description":"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.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `size`: Supply an integer value between 10 and 100, inclusive. The default value is 100.\n\n- `page`: Supply an integer value. The default value is 0.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Authorization\n\nAny Soda Cloud user in your organization may execute this query.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"GET/api/v1/datasets/roles","parameters":[{"in":"query","name":"page","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetRolesResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List dataset roles","tags":["Datasets"]}}}} ``` ## Create a dataset role > This endpoint allows you to create a new custom dataset role in your organization's Soda Cloud account. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\ > \ > Once created, the role can be assigned to users or user groups via the dataset responsibilities endpoints.\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Authorization\ > \ > Users must have global role permission MANAGE\_ORGANISATION\_SETTINGS to execute this call.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 60 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetRoleRequestDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["name"]},"PublicApiCreateDatasetRoleResponse":{"type":"object","properties":{"datasetRole":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"}},"required":["datasetRole"]},"DatasetRoleContentDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"executeContracts":{"type":"boolean","deprecated":true},"id":{"type":"string"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"publishContracts":{"type":"boolean","deprecated":true},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["id","name"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/roles":{"post":{"description":"This endpoint allows you to create a new custom dataset role in your organization's Soda Cloud account. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\n\nOnce created, the role can be assigned to users or user groups via the dataset responsibilities endpoints.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Authorization\n\nUsers must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"POST/api/v1/datasets/roles","requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetRoleRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateDatasetRoleResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create a dataset role","tags":["Datasets"]}}}} ``` ## Update a dataset role > This endpoint allows you to update the name or permissions of an existing custom dataset role. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\ > \ > Changes apply immediately to all users and user groups assigned this role.\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Authorization\ > \ > Users must have global role permission MANAGE\_ORGANISATION\_SETTINGS to execute this call.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 60 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetRoleRequestDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["name"]},"PublicApiUpdateDatasetRoleResponse":{"type":"object","properties":{"datasetRole":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"}},"required":["datasetRole"]},"DatasetRoleContentDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"executeContracts":{"type":"boolean","deprecated":true},"id":{"type":"string"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"publishContracts":{"type":"boolean","deprecated":true},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["id","name"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/roles/{roleId}":{"post":{"description":"This endpoint allows you to update the name or permissions of an existing custom dataset role. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\n\nChanges apply immediately to all users and user groups assigned this role.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Authorization\n\nUsers must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"POST/api/v1/datasets/roles/{roleId}","parameters":[{"in":"path","name":"roleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetRoleRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasetRoleResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update a dataset role","tags":["Datasets"]}}}} ``` ## Delete a dataset role > This endpoint allows you to delete a custom dataset role from your organization's Soda Cloud account. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\ > \ > Deletion is performed asynchronously and may take some time to complete.\ > \ > Deletion will fail if the role is still assigned to any dataset permissions or used in responsibility settings.\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Authorization\ > \ > Users must have global role permission MANAGE\_ORGANISATION\_SETTINGS to execute this call.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 60 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDeleteDatasetRoleResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/roles/{roleId}":{"delete":{"description":"This endpoint allows you to delete a custom dataset role from your organization's Soda Cloud account. Dataset roles define a named set of permissions that control what actions users can perform on individual datasets, such as managing checks, viewing profiling data, configuring the dataset, or managing incidents.\n\nDeletion is performed asynchronously and may take some time to complete.\n\nDeletion will fail if the role is still assigned to any dataset permissions or used in responsibility settings.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Authorization\n\nUsers must have global role permission MANAGE_ORGANISATION_SETTINGS to execute this call.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n60 requests/60 seconds","operationId":"DELETE/api/v1/datasets/roles/{roleId}","parameters":[{"in":"path","name":"roleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDeleteDatasetRoleResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete a dataset role","tags":["Datasets"]}}}} ``` ## Get dataset > This endpoint enables you to retrieve a single dataset by its ID from your organization's Soda Cloud account.\ > \ > \## Authorization\ > \ > Only users with \*\*View dataset\*\* permission can view a dataset. Soda Cloud Admins have permission to view any dataset. \*\*See \[Manage dataset roles]\() for more information.\*\*\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 1000 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"DatasetsContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checks":{"type":"number"},"cloudUrl":{"type":"string"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO"},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"healthStatus":{"type":"integer","format":"int32"},"id":{"type":"string"},"incidents":{"type":"number"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}},"required":["checks","cloudUrl","healthStatus","id","incidents","name"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataQualityStatusDTO":{"type":"string","enum":["pass","warn","fail"]},"DatasourcePropertiesDTO":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"type":{"type":"string"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}}},"ModelVersionDTO":{"type":"string","enum":["3","4"]},"DatasetOwnerDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["name","userGroupId"]},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}":{"get":{"description":"This endpoint enables you to retrieve a single dataset by its ID from your organization's Soda Cloud account.\n\n## Authorization\n\nOnly users with **View dataset** permission can view a dataset. Soda Cloud Admins have permission to view any dataset. **See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DatasetsContentDTO"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset","tags":["Datasets"]}}}} ``` ## Update dataset > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiUpdateDatasetDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"computeWarehouseOverride":{"type":"object","$ref":"#/components/schemas/UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO"},"diagnosticsWarehouse":{"type":"object","$ref":"#/components/schemas/UpdateDatasetDiagnosticsWarehouseConfigurationRequestDTO"},"label":{"type":"string"},"metricMonitoring":{"type":"object","$ref":"#/components/schemas/UpdateDatasetMetricMonitoringConfigurationRequestDTO"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasetOwnerRequestDTO"}},"partitionColumn":{"type":"string","deprecated":true},"profiling":{"type":"object","$ref":"#/components/schemas/UpdateDatasetProfilingConfigurationRequestDTO"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/UpdateDatasetTimePartitionRequestDTO"}}},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO":{"type":"object","properties":{"computeWarehouseConfiguration":{"type":"object","$ref":"#/components/schemas/UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO_WarehouseConfigurationDTO"},"enabled":{"type":"boolean"}}},"UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO_WarehouseConfigurationDTO":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"UpdateDatasetDiagnosticsWarehouseConfigurationRequestDTO":{"type":"object","properties":{"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/DatasetDiagnosticsWarehouseFailedRowsConfigurationRequest"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/DatasetDiagnosticsWarehouseScanAndResultsConfigurationRequest"},"schema":{"type":"string"}}},"DatasetDiagnosticsWarehouseFailedRowsConfigurationRequest":{"type":"object","properties":{"enabled":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"maxRowCount":{"type":"integer","format":"int32"},"schema":{"type":"string","deprecated":true},"storageStrategy":{"type":"object","$ref":"#/components/schemas/DiagnosticsWarehouseFailedRowsStorageStrategyDTO"},"uniqueKeyColumnNames":{"type":"array","items":{"type":"string"}}}},"FailedRowSamplesDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"sampleSize":{"type":"integer","format":"int32"}}},"FailedRowsCollectionStrategyDTO":{"type":"object","properties":{"maxRowCountOverride":{"type":"integer","format":"int32"},"threshold":{"type":"number"},"thresholdCondition":{"type":"object","$ref":"#/components/schemas/ThresholdConditionDTO"},"type":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyTypeDTO"}},"required":["threshold","thresholdCondition"]},"ThresholdConditionDTO":{"type":"string","enum":["greaterThan","lessThan"]},"FailedRowsCollectionStrategyTypeDTO":{"type":"string","enum":["useDefaultMaxRowCount","absolute","percentage"]},"DiagnosticsWarehouseFailedRowsStorageStrategyDTO":{"type":"string","enum":["fullFailedRows","uniqueKeys","scansAndResultsOnly"]},"DatasetDiagnosticsWarehouseScanAndResultsConfigurationRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"UpdateDatasetMetricMonitoringConfigurationRequestDTO":{"type":"object","properties":{"datasetMetricMonitorsConfiguration":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO"}},"enabled":{"type":"boolean"},"historicalMetricCollectionScanStartDate":{"type":"string","format":"date-time"},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"}}},"DatasetMetricMonitorConfigurationDTO":{"type":"object","properties":{"configuration":{"type":"object","$ref":"#/components/schemas/DatasetMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/DatasetMonitorMetricTypeDTO"}},"required":["configuration","metricType"]},"DatasetMonitorConfigurationDTO":{"type":"object","properties":{"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"DatasetMonitorMetricTypeDTO":{"type":"string","enum":["rowCount","freshness","schema","rowsInserted","totalRowCountChange","timeliness"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]},"PublicApiUpdateDatasetOwnerRequestDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]},"UpdateDatasetProfilingConfigurationRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"profilingSamplingStrategy":{"type":"object","$ref":"#/components/schemas/ProfilingSamplingStrategyConfigurationDTO"},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"}}},"ProfilingSamplingStrategyConfigurationDTO":{"type":"object","properties":{"numberOfRows":{"type":"integer","format":"int32"},"numberOfUnits":{"type":"integer","format":"int32"},"unitOfTime":{"type":"object","$ref":"#/components/schemas/UnitOfTimeDTO"}}},"UnitOfTimeDTO":{"type":"string","enum":["hours","days","weeks"]},"UpdateDatasetTimePartitionRequestDTO":{"type":"object","properties":{"partitionColumn":{"type":"string"},"sqlExpression":{"type":"string"}}},"DatasetsContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checks":{"type":"number"},"cloudUrl":{"type":"string"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO"},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"healthStatus":{"type":"integer","format":"int32"},"id":{"type":"string"},"incidents":{"type":"number"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}},"required":["checks","cloudUrl","healthStatus","id","incidents","name"]},"DataQualityStatusDTO":{"type":"string","enum":["pass","warn","fail"]},"DatasourcePropertiesDTO":{"type":"object","properties":{"label":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"type":{"type":"string"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}}},"ModelVersionDTO":{"type":"string","enum":["3","4"]},"DatasetOwnerDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"}},"required":["type"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"UserGroupContentBasicDTO":{"type":"object","properties":{"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["name","userGroupId"]},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}":{"post":{"description":"This endpoint enables you to update an existing dataset properties in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly users with **Configure dataset** permission can update dataset properties. Soda Cloud Admins have permission to update all datasets.**See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasetDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DatasetsContentDTO"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update dataset","tags":["Datasets"]}}}} ``` ## Delete dataset > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 10 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDeleteDatasetResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}":{"delete":{"description":"This endpoint enables you to delete an existing dataset in your organization's Soda Cloud account. \n\nDeletion 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.\n\n## Authorization\n\nOnly users with **Delete dataset** permission can delete a dataset. Soda Cloud Admins have permission to delete any dataset.**See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n10 requests/60 seconds","operationId":"DELETE/api/v1/datasets/{datasetId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDeleteDatasetResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete dataset","tags":["Datasets"]}}}} ``` ## Create a column metric monitor > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiCreateColumnMetricMonitorRequestDTO":{"type":"object","properties":{"columnMetricMonitorConfiguration":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorConfigurationDTO"},"columnName":{"type":"string"}},"required":["columnMetricMonitorConfiguration","columnName"]},"ColumnMetricMonitorConfigurationDTO":{"type":"object","properties":{"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["configuration","metricType"]},"ColumnMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumns":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"ColumnMonitorMetricTypeDTO":{"type":"string","enum":["missingPercentage","duplicatePercentage","average","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3"]},"PublicApiCreateColumnMetricMonitorResponse":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO"}},"required":["columnMetricMonitor"]},"ColumnMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["checkId","columnName","configuration","metricType"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/columnMetricMonitors":{"post":{"description":"This endpoint allows you to create a new column metric monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/columnMetricMonitors","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateColumnMetricMonitorRequestDTO"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateColumnMetricMonitorResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create a column metric monitor","tags":["Datasets"]}}}} ``` ## Update a column metric monitor > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiUpdateColumnMetricMonitorRequestDTO":{"type":"object","properties":{"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"}},"required":["configuration"]},"ColumnMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumns":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"PublicApiUpdateColumnMetricMonitorResponse":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO"}},"required":["columnMetricMonitor"]},"ColumnMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["checkId","columnName","configuration","metricType"]},"ColumnMonitorMetricTypeDTO":{"type":"string","enum":["missingPercentage","duplicatePercentage","average","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}":{"post":{"description":"This endpoint allows you to update an existing column metric monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"monitorId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateColumnMetricMonitorRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateColumnMetricMonitorResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update a column metric monitor","tags":["Datasets"]}}}} ``` ## Delete a column metric monitor > This endpoint allows you to delete a column metric monitor for a specific dataset in your organization's Soda Cloud account.\ > \ > \## Authorization\ > \ > Only users with \*\*Manage checks\*\* permission can delete column metric monitors. Soda Cloud Admins can delete column metric monitors for all datasets. \*\*See \[Manage dataset roles]\() for more information.\*\*\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDeleteColumnMetricMonitorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}":{"delete":{"description":"This endpoint allows you to delete a column metric monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly users with **Manage checks** permission can delete column metric monitors. Soda Cloud Admins can delete column metric monitors for all datasets. **See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"DELETE/api/v1/datasets/{datasetId}/columnMetricMonitors/{monitorId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"monitorId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDeleteColumnMetricMonitorResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete a column metric monitor","tags":["Datasets"]}}}} ``` ## Get dataset compute warehouse configuration > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"DatasetComputeWarehouseConfigurationDTO":{"type":"object","properties":{"availableWarehouses":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO"}},"currentWarehouse":{"type":"object","$ref":"#/components/schemas/DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO"},"datasetWarehouseOverride":{"type":"object","$ref":"#/components/schemas/DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO"},"defaultWarehouse":{"type":"object","$ref":"#/components/schemas/DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO"},"enabled":{"type":"boolean"}}},"DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/computeWarehouse":{"get":{"description":"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.\n\n## Authorization\n\nOnly users with **View dataset** permission can retrieve dataset compute warehouse configuration. Soda Cloud Admins have permission to view all datasets.**See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}/computeWarehouse","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/DatasetComputeWarehouseConfigurationDTO"}}},"description":"Successful response"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset compute warehouse configuration","tags":["Datasets"]}}}} ``` ## Create a custom SQL monitor > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiCreateCustomSqlMonitorRequestDTO":{"type":"object","properties":{"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/CustomSqlMonitorConfigurationDTO"},"monitorName":{"type":"string"}},"required":["configuration","monitorName"]},"CustomSqlMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","items":{"type":"string"}},"resultMetric":{"type":"string"},"sqlQuery":{"type":"string"},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}},"required":["resultMetric","sqlQuery"]},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"PublicApiCreateCustomSqlMonitorResponse":{"type":"object","properties":{"customSqlMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO"}},"required":["customSqlMonitor"]},"CustomMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/CustomSqlMonitorConfigurationDTO"},"monitorName":{"type":"string"}},"required":["checkId","configuration","monitorName"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/customSqlMonitors":{"post":{"description":"This endpoint allows you to create a new custom SQL monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/customSqlMonitors","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateCustomSqlMonitorRequestDTO"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiCreateCustomSqlMonitorResponse"}}},"description":"Created"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Create a custom SQL monitor","tags":["Datasets"]}}}} ``` ## Update a custom SQL monitor > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiUpdateCustomSqlMonitorRequestDTO":{"type":"object","properties":{"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/CustomSqlMonitorConfigurationUpdateDTO"},"name":{"type":"string"}}},"CustomSqlMonitorConfigurationUpdateDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","items":{"type":"string"}},"resultMetric":{"type":"string"},"sqlQuery":{"type":"string"},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"PublicApiUpdateCustomSqlMonitorResponse":{"type":"object","properties":{"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO"}},"required":["customSqlMetricMonitor"]},"CustomMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/CustomSqlMonitorConfigurationDTO"},"monitorName":{"type":"string"}},"required":["checkId","configuration","monitorName"]},"CustomSqlMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","items":{"type":"string"}},"resultMetric":{"type":"string"},"sqlQuery":{"type":"string"},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}},"required":["resultMetric","sqlQuery"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}":{"post":{"description":"This endpoint allows you to update an existing custom SQL monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"monitorId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateCustomSqlMonitorRequestDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateCustomSqlMonitorResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update a custom SQL monitor","tags":["Datasets"]}}}} ``` ## Delete a custom SQL monitor > This endpoint allows you to delete a custom SQL monitor for a specific dataset in your organization's Soda Cloud account.\ > \ > \## Authorization\ > \ > Only users with \*\*Manage checks\*\* permission can delete custom SQL monitors. Soda Cloud Admins can delete custom SQL monitors for all datasets. \*\*See \[Manage dataset roles]\() for more information.\*\*\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDeleteCustomSqlMonitorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}":{"delete":{"description":"This endpoint allows you to delete a custom SQL monitor for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly users with **Manage checks** permission can delete custom SQL monitors. Soda Cloud Admins can delete custom SQL monitors for all datasets. **See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"DELETE/api/v1/datasets/{datasetId}/customSqlMonitors/{monitorId}","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"path","name":"monitorId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDeleteCustomSqlMonitorResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Delete a custom SQL monitor","tags":["Datasets"]}}}} ``` ## Get dataset diagnostics warehouse information > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 1000 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetDiagnosticsWarehouseResponse":{"type":"object","properties":{"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseFailedRowsConfigurationDTO"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO"}}},"PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseFailedRowsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"maxRowCount":{"type":"integer","format":"int32"},"state":{"type":"object","$ref":"#/components/schemas/FailedRowsConfigurationStateDTO"},"storageStrategy":{"type":"object","$ref":"#/components/schemas/DiagnosticsWarehouseFailedRowsStorageStrategyDTO"},"uniqueKeyColumnNames":{"type":"array","items":{"type":"string"}}}},"FailedRowSamplesDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"sampleSize":{"type":"integer","format":"int32"}}},"FailedRowsCollectionStrategyDTO":{"type":"object","properties":{"maxRowCountOverride":{"type":"integer","format":"int32"},"threshold":{"type":"number"},"thresholdCondition":{"type":"object","$ref":"#/components/schemas/ThresholdConditionDTO"},"type":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyTypeDTO"}},"required":["threshold","thresholdCondition"]},"ThresholdConditionDTO":{"type":"string","enum":["greaterThan","lessThan"]},"FailedRowsCollectionStrategyTypeDTO":{"type":"string","enum":["useDefaultMaxRowCount","absolute","percentage"]},"FailedRowsConfigurationStateDTO":{"type":"string","enum":["ready","doNotDetectAutomatically","awaitingPrimaryKeysInformationFromAgent","errorMissingUniqueKeys"]},"DiagnosticsWarehouseFailedRowsStorageStrategyDTO":{"type":"string","enum":["fullFailedRows","uniqueKeys","scansAndResultsOnly"]},"PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/diagnosticsWarehouse":{"get":{"description":"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.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}/diagnosticsWarehouse","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset diagnostics warehouse information","tags":["Datasets"]}}}} ``` ## Get dataset metric monitoring configuration information > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 1000 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetMetricMonitoringResponse":{"type":"object","properties":{"columnMetricMonitors":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO"}},"customSqlMetricMonitors":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO"}},"datasetId":{"type":"string"},"datasetMetricMonitorsConfiguration":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO"}},"enabled":{"type":"boolean"},"historicalMetricCollectionScanStartDate":{"type":"string","format":"date-time"},"partitionColumn":{"type":"string","deprecated":true},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}}},"ColumnMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["checkId","columnName","configuration","metricType"]},"ColumnMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumns":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]},"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]},"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]},"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}},"ColumnMonitorMetricTypeDTO":{"type":"string","enum":["missingPercentage","duplicatePercentage","average","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3"]},"CustomMetricMonitorDTO":{"type":"object","properties":{"checkId":{"type":"string"},"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/CustomSqlMonitorConfigurationDTO"},"monitorName":{"type":"string"}},"required":["checkId","configuration","monitorName"]},"CustomSqlMonitorConfigurationDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","items":{"type":"string"}},"resultMetric":{"type":"string"},"sqlQuery":{"type":"string"},"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}},"required":["resultMetric","sqlQuery"]},"DatasetMetricMonitorConfigurationDTO":{"type":"object","properties":{"configuration":{"type":"object","$ref":"#/components/schemas/DatasetMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/DatasetMonitorMetricTypeDTO"}},"required":["configuration","metricType"]},"DatasetMonitorConfigurationDTO":{"type":"object","properties":{"exclusionZones":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ExclusionZoneDTO"}},"isEnabled":{"type":"boolean"},"isSamplingEnabled":{"type":"boolean"},"sensitivity":{"type":"number"},"thresholdStrategy":{"type":"object","$ref":"#/components/schemas/ThresholdStrategyDTO"},"validRange":{"type":"object","$ref":"#/components/schemas/ValidRangeDTO"}}},"DatasetMonitorMetricTypeDTO":{"type":"string","enum":["rowCount","freshness","schema","rowsInserted","totalRowCountChange","timeliness"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/metricMonitoring":{"get":{"description":"This endpoint allows you to retrieve detailed metric monitoring configuration information for a specific dataset in your organization's Soda Cloud account.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}/metricMonitoring","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetMetricMonitoringResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset metric monitoring configuration information","tags":["Datasets"]}}}} ``` ## Run historical metric collection for a dataset > This endpoint triggers a historical metric collection scan for a specific dataset in your organization's Soda Cloud account.\ > \ > The dataset must have metric monitoring enabled and a historical collection scan definition configured.\ > \ > The response includes the scan ID and a Location header pointing to the scan status endpoint.\ > \ > \## Authorization\ > \ > Only users with \*\*Manage checks\*\* permission can run historical metric collection. Soda Cloud Admins have access to run historical metric collection for all datasets. \*\*See \[Manage dataset roles]\() for more information.\*\*\ > \ > \## Authentication\ > \ > User authentication required: \`true\`\ > \ > This endpoint accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 10 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/metricMonitoring/historicalMetricCollection":{"post":{"description":"This endpoint triggers a historical metric collection scan for a specific dataset in your organization's Soda Cloud account.\n\nThe dataset must have metric monitoring enabled and a historical collection scan definition configured.\n\nThe response includes the scan ID and a Location header pointing to the scan status endpoint.\n\n## Authorization\n\nOnly users with **Manage checks** permission can run historical metric collection. Soda Cloud Admins have access to run historical metric collection for all datasets. **See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n10 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/metricMonitoring/historicalMetricCollection","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","headers":{"Location":{"schema":{"type":"string"}},"X-Soda-Scan-Id":{"schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Run historical metric collection for a dataset","tags":["Datasets"]}}}} ``` ## Get dataset profiling information > 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 1000 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetProfilingResponse":{"type":"object","properties":{"columnCount":{"type":"number"},"columns":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetColumnProfilingContentDTO"}},"datasetId":{"type":"string"},"enabled":{"type":"boolean"},"partitionColumn":{"type":"string","deprecated":true},"profilingTime":{"type":"string","format":"date-time"},"rowCount":{"type":"number"},"samplingStrategyConfiguration":{"type":"object","$ref":"#/components/schemas/ProfilingSamplingStrategyConfigurationDTO"},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}},"required":["columns","datasetId"]},"DatasetColumnProfilingContentDTO":{"type":"object","properties":{"id":{"type":"string"},"metrics":{"type":"object","$ref":"#/components/schemas/ColumnMetricContentDTO"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]},"ColumnMetricContentDTO":{"type":"object","properties":{"average":{"type":"number"},"averageLength":{"type":"number"},"distinctCount":{"type":"number"},"extremeValues":{"type":"object","$ref":"#/components/schemas/ExtremeValuesContentDTO"},"frequentValues":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ValueCountContentDTO"}},"histogram":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/HistogramBinContentDTO"}},"maximum":{"type":"object","$ref":"#/components/schemas/_object"},"maximumLength":{"type":"integer","format":"int32"},"maximumTimestamp":{"type":"string","format":"date-time"},"median":{"type":"number"},"minimum":{"type":"object","$ref":"#/components/schemas/_object"},"minimumLength":{"type":"integer","format":"int32"},"minimumTimestamp":{"type":"string","format":"date-time"},"missingCount":{"type":"number"},"standardDeviation":{"type":"number"},"sum":{"type":"number"},"variance":{"type":"number"}}},"ExtremeValuesContentDTO":{"type":"object","properties":{"maximum":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/_object"}},"minimum":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/_object"}}}},"_object":{"type":"object"},"ValueCountContentDTO":{"type":"object","properties":{"count":{"type":"number"},"value":{"type":"object","$ref":"#/components/schemas/_object"}}},"HistogramBinContentDTO":{"type":"object","properties":{"count":{"type":"number"},"lowerBound":{"type":"number"},"upperBound":{"type":"number"}},"required":["count","lowerBound","upperBound"]},"ProfilingSamplingStrategyConfigurationDTO":{"type":"object","properties":{"numberOfRows":{"type":"integer","format":"int32"},"numberOfUnits":{"type":"integer","format":"int32"},"unitOfTime":{"type":"object","$ref":"#/components/schemas/UnitOfTimeDTO"}}},"UnitOfTimeDTO":{"type":"string","enum":["hours","days","weeks"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]},"DatasetTimePartitionDTO":{"type":"object","properties":{"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO"},"sqlExpression":{"type":"string"},"timePartitionType":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionTypeDTO"}}},"DatasetPartitionColumnContentDTO":{"type":"object","properties":{"columnType":{"type":"object","$ref":"#/components/schemas/ColumnTypeDTO"},"name":{"type":"string"}},"required":["columnType","name"]},"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]},"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/profiling":{"get":{"description":"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.\n\n## Authorization\n\nOnly 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n1000 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}/profiling","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetProfilingResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Get dataset profiling information","tags":["Datasets"]}}}} ``` ## List dataset 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiDatasetResponsibilitiesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetResponsibilityContentDTO"}},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int32"},"totalPages":{"type":"integer","format":"int32"}},"required":["content","first","last","number","size","totalElements","totalPages"]},"DatasetResponsibilityContentDTO":{"type":"object","properties":{"managed":{"type":"boolean"},"role":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["managed","role","type"]},"DatasetRoleContentDTO":{"type":"object","properties":{"configureDataset":{"type":"boolean"},"createCheckProposals":{"type":"boolean"},"deleteDataset":{"type":"boolean"},"executeContracts":{"type":"boolean","deprecated":true},"id":{"type":"string"},"manageChecks":{"type":"boolean"},"manageContracts":{"type":"boolean"},"manageIncidents":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"publishContracts":{"type":"boolean","deprecated":true},"viewFailedRows":{"type":"boolean"},"viewProfilingAndSamples":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/responsibilities":{"get":{"description":"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.\n\nThis GET is a paginated API that uses the following parameters to request specific details:\n\n- `size`: Supply an integer value between 1 and 100, inclusive. The default value is 100.\n\n- `page`: Supply an integer value. The default value is 0.\n\n## Authorization\n\nSoda 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](https://go.soda.io/roles-dataset) for more information.**\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"GET/api/v1/datasets/{datasetId}/responsibilities","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"in":"query","name":"page","schema":{"type":"integer","format":"int32"}},{"in":"query","name":"size","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetResponsibilitiesResponse"}}},"description":"Successful response"},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"List dataset responsibilities","tags":["Datasets"]}}}} ``` ## Update dataset 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 accepts authentication via API keys in the \`Basic\` authentication header, or a pre-authenticated token in HTTP cookie \`token\`. Cookie sessions extend automatically on each request.\ > \ > \## Tags\ > \ > \`Datasets\`\ > \ > \## Rate limiting\ > \ > 100 requests/60 seconds ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"tags":[{"description":"Soda Cloud API Dataset Endpoints","name":"Datasets"}],"servers":[{"description":"Cloud EU","url":"https://cloud.soda.io"},{"description":"Cloud US","url":"https://cloud.us.soda.io"}],"security":[{"basicAuthApiKey":[]},{"cookieToken":[]}],"components":{"securitySchemes":{"basicAuthApiKey":{"scheme":"basic","type":"http"},"cookieToken":{"in":"cookie","name":"token","type":"apiKey"}},"schemas":{"PublicApiUpdateDatasetResponsibilitiesRequestDTO":{"type":"object","properties":{"responsibilities":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetResponsibilityContentRequestDTO"}}},"required":["responsibilities"]},"DatasetResponsibilityContentRequestDTO":{"type":"object","properties":{"roleId":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["roleId","type"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]},"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}},"paths":{"/api/v1/datasets/{datasetId}/responsibilities":{"post":{"description":"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.\n\n**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.\n\n## Authorization\n\nOnly users with **Manage dataset responsibilities** permission can update dataset responsibilities. Soda Cloud Admins have permission to update all datasets responsibilities.**See [Manage dataset roles](https://go.soda.io/roles-dataset) 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.\n\n## Authentication\n\nUser authentication required: `true`\n\nThis endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.\n\n## Tags\n\n`Datasets`\n\n## Rate limiting\n\n100 requests/60 seconds","operationId":"POST/api/v1/datasets/{datasetId}/responsibilities","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasetResponsibilitiesRequestDTO"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"schema":{"type":"string"}}}},"400":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"429":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too many requests"},"500":{"content":{"application/json":{"schema":{"type":"object","$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal server error"}},"summary":"Update dataset responsibilities","tags":["Datasets"]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.soda.io/reference/rest-api/datasets.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.