> For the complete documentation index, see [llms.txt](https://docs.soda.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.soda.io/apis/rest-api/models.md). # Models ## The AggregateDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The AggregateDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}}}}} ``` ## The AgreementSlimDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AgreementSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The AttributeContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AttributeContentDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"resourceType":{"type":"object","$ref":"#/components/schemas/AttributeResourceTypeDTO"},"type":{"type":"object","$ref":"#/components/schemas/AttributeTypeDTO"}},"required":["id","label","name","resourceType","type"]},"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]},"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The AttributeResourceTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]}}}} ``` ## The AttributeTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The AuditLogDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AuditLogDTO":{"type":"object","properties":{"auditSteps":{"type":"array","description":"Details recorded during the operation, in recorded order. Empty when no steps were logged.","items":{"type":"object","$ref":"#/components/schemas/AuditLogStepDTO"}},"comment":{"type":"string","description":"Audited operation, usually a request or command name."},"email":{"type":"string"},"eventTime":{"type":"string","format":"date-time","description":"Timestamp of the overall operation in UTC at whole-second precision, used for filtering and ordering."},"id":{"type":"string"},"ipAddress":{"type":"string"},"maskedApiKey":{"type":"string","description":"Masked API key. Keys longer than eight characters retain the first and last two characters; keys of eight characters or fewer are fully masked."}},"required":["auditSteps","eventTime","id"]},"AuditLogStepDTO":{"type":"object","properties":{"comment":{"type":"string","description":"Detail or outcome recorded at this step of the operation."},"eventTime":{"type":"string","format":"date-time","description":"Timestamp of this step in UTC, retaining its original sub-second precision."}}}}}} ``` ## The AuditLogStepDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"AuditLogStepDTO":{"type":"object","properties":{"comment":{"type":"string","description":"Detail or outcome recorded at this step of the operation."},"eventTime":{"type":"string","format":"date-time","description":"Timestamp of this step in UTC, retaining its original sub-second precision."}}}}}} ``` ## The BulkSubmitMonitorResultFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"BulkSubmitMonitorResultFeedbackDTO":{"type":"object","properties":{"feedback":{"type":"object","$ref":"#/components/schemas/SubmitMonitorResultFeedbackDTO"},"resultIds":{"type":"array","description":"The monitor results that all get the same feedback. Every id must exist and belong to a metric monitor of a V4 dataset, otherwise nothing is written.","items":{"type":"string"}}},"required":["feedback","resultIds"]},"SubmitMonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly."}},"required":["isCorrectlyClassified"]}}}} ``` ## The CheckResultAnomalyDetectionDetailsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}}}}} ``` ## The CheckResultContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultContentDTO":{"type":"object","properties":{"anomalyDetectionDetails":{"type":"object","$ref":"#/components/schemas/CheckResultAnomalyDetectionDetailsDTO","deprecated":true},"checkId":{"type":"string"},"dataTimestamp":{"type":"string","format":"date-time"},"diagnostics":{"type":"object","$ref":"#/components/schemas/CheckResultDiagnosticsV4"},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO","description":"Feedback given on this result. Only anomaly detection results carry it."},"id":{"type":"string"},"incident":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"},"measure":{"type":"object","$ref":"#/components/schemas/MeasureDTO"},"scanId":{"type":"string"},"scanTime":{"type":"string","format":"date-time"},"value":{"type":"number"},"valueLabel":{"type":"string"},"valueSeries":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO"}},"required":["checkId","dataTimestamp","evaluationStatus","id"]},"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}},"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]},"MeasureDTO":{"type":"string","enum":["time"]},"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}}}}} ``` ## The CheckResultDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}}}}} ``` ## The CheckResultLevelDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]}}}} ``` ## The CheckResultValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultValueDTO":{"type":"object","properties":{"anomalyDetectionDetails":{"type":"object","$ref":"#/components/schemas/CheckResultAnomalyDetectionDetailsDTO","deprecated":true},"dataTimestamp":{"type":"string","format":"date-time"},"diagnostics":{"type":"object","$ref":"#/components/schemas/CheckResultDiagnosticsV4"},"id":{"type":"string"},"measure":{"type":"object","$ref":"#/components/schemas/MeasureDTO"},"value":{"type":"number"},"valueLabel":{"type":"string"},"valueSeries":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO"}},"required":["id"]},"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}},"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}},"MeasureDTO":{"type":"string","enum":["time"]},"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]}}}} ``` ## The CheckResultValueSeriesDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]}}}} ``` ## The CheckResultValueSeriesDTO\_ValueSeriesValue object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]}}}} ``` ## The CheckSortFieldDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckSortFieldDTO":{"type":"string","enum":["name","createdAt"]}}}} ``` ## The CheckSortOrderDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckSortOrderDTO":{"type":"string","enum":["asc","desc"]}}}} ``` ## The CheckSourceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckSourceDTO":{"type":"string","enum":["soda-sql","soda-core","soda-library","soda-cloud","dbt","soda-contract","data-standard","soda-metric-monitoring"]}}}} ``` ## The CheckTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CheckTypeDTO":{"type":"string","enum":["missing","invalid","row_count","aggregate","schema","duplicate","freshness","failed_rows","metric","group_by","row_count_diff","aggregate_diff","freshness_diff","metric_diff","rows_diff","duplicate_diff","llm","hierarchy","fuzzy_duplicate","reference_diff","schema_diff"]}}}} ``` ## The ChecksContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ChecksContentDTO":{"type":"object","properties":{"agreements":{"type":"array","deprecated":true,"items":{"type":"object","$ref":"#/components/schemas/AgreementSlimDTO"}},"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringToString"},"checkType":{"type":"string"},"cloudUrl":{"type":"string"},"column":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetSlimDTO"}},"definition":{"type":"string","description":"The check as the runner last sent it. For checks whose `source` is `soda-contract` or `data-standard`: a YAML fragment of the contract or data standard with only this check in it, under its check type key. Older runners leave out the check type key and the `reconciliation` block, so use `checkType`. For other sources: the check text, such as SodaCL."},"description":{"type":"string"},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"group":{"type":"object","$ref":"#/components/schemas/ChecksContentDTO_Group"},"id":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"}},"lastCheckResultValue":{"type":"object","$ref":"#/components/schemas/CheckResultValueDTO"},"lastCheckRunTime":{"type":"string","format":"date-time","deprecated":true},"lastUpdated":{"type":"string","format":"date-time","deprecated":true},"metricType":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/OwnerDTO","deprecated":true},"source":{"type":"object","$ref":"#/components/schemas/CheckSourceDTO","description":"Where the check was defined. Null for checks whose source is not known to Soda Cloud."}},"required":["createdAt","datasets","evaluationStatus","id","incidents","name"]},"AgreementSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"name":{"type":"string"}}},"MapOfStringToString":{"type":"object","additionalProperties":true},"DatasetSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"ChecksContentDTO_Group":{"type":"object","properties":{"groupType":{"type":"string"},"identity":{"type":"string"},"name":{"type":"string"}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]},"CheckResultValueDTO":{"type":"object","properties":{"anomalyDetectionDetails":{"type":"object","$ref":"#/components/schemas/CheckResultAnomalyDetectionDetailsDTO","deprecated":true},"dataTimestamp":{"type":"string","format":"date-time"},"diagnostics":{"type":"object","$ref":"#/components/schemas/CheckResultDiagnosticsV4"},"id":{"type":"string"},"measure":{"type":"object","$ref":"#/components/schemas/MeasureDTO"},"value":{"type":"number"},"valueLabel":{"type":"string"},"valueSeries":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO"}},"required":["id"]},"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}},"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}},"MeasureDTO":{"type":"string","enum":["time"]},"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}},"OwnerDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"}}},"CheckSourceDTO":{"type":"string","enum":["soda-sql","soda-core","soda-library","soda-cloud","dbt","soda-contract","data-standard","soda-metric-monitoring"]}}}} ``` ## The ChecksContentDTO\_Group object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ChecksContentDTO_Group":{"type":"object","properties":{"groupType":{"type":"string"},"identity":{"type":"string"},"name":{"type":"string"}}}}}} ``` ## The ColumnMetricContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ColumnMetricContentDTO":{"type":"object","properties":{"average":{"type":"number"},"averageLength":{"type":"number"},"distinctCount":{"type":"integer","format":"int64"},"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":"integer","format":"int64"},"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":"integer","format":"int64"},"value":{"type":"object","$ref":"#/components/schemas/_object"}}},"HistogramBinContentDTO":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"lowerBound":{"type":"number"},"upperBound":{"type":"number"}},"required":["count","lowerBound","upperBound"]}}}} ``` ## The ColumnMetricMonitorConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The ColumnMetricMonitorDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The ColumnMonitorConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The ColumnMonitorMetricTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ColumnMonitorMetricTypeDTO":{"type":"string","enum":["missingPercentage","duplicatePercentage","average","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3"]}}}} ``` ## The ColumnTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ColumnTypeDTO":{"type":"string","enum":["unknown","string","integer","float","time","boolean","date","dateTime"]}}}} ``` ## The ContractChangeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ContractChangeRequestDTO":{"type":"object","properties":{"authorId":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/ContractChangeRequestStatusDTO"},"title":{"type":"string"}}},"ContractChangeRequestStatusDTO":{"type":"string","enum":["open","wontDo","done","draft","ready","waiting","inReview"]}}}} ``` ## The ContractChangeRequestStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ContractChangeRequestStatusDTO":{"type":"string","enum":["open","wontDo","done","draft","ready","waiting","inReview"]}}}} ``` ## The ContractContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ContractContentDTO":{"type":"object","properties":{"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}} ``` ## The ContractVersionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ContractVersionDTO":{"type":"object","properties":{"checksum":{"type":"string"},"contents":{"type":"string"},"contractId":{"type":"string"},"created":{"type":"string","format":"date-time"},"creatorId":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The CreateColumnMetricMonitorDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CreateColumnMetricMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["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"]}}}} ``` ## The CreateCustomSqlMonitorDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"CreateCustomSqlMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string","description":"Optional column to associate with the monitor. If not specified, the monitor is associated with the full dataset. This is metadata only, it does not affect how the monitor operates."},"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"}}}}}} ``` ## The CustomMetricMonitorDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]},"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"}}}}}} ``` ## The CustomSqlMonitorConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The CustomSqlMonitorConfigurationUpdateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The DataProductCheckResultsContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductCheckResultsContentDTO":{"type":"object","properties":{"criticalFailingCount":{"type":"integer","format":"int32","description":"A subset of failingCount: the failing checks whose `severity` check attribute is `critical`."},"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["criticalFailingCount","failingCount","notEvaluatedCount","passingCount","warningCount"]}}}} ``` ## The DataProductContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The `key` of the data product YAML. It is unique in the organization and cannot change. Use it as `dataProductName` in the paths."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The DataProductHealthContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]}}}} ``` ## The DataProductHealthInputCountsContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]}}}} ``` ## The DataProductHealthStateContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]}}}} ``` ## The DataProductInputContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductInputContentDTO":{"type":"object","properties":{"checkResults":{"type":"object","$ref":"#/components/schemas/DataProductCheckResultsContentDTO"},"datasetId":{"type":"string"},"dqn":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductInputHealthContentDTO"},"id":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductInputStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductInputTypeContentDTO"}},"required":["id","state","type"]},"DataProductCheckResultsContentDTO":{"type":"object","properties":{"criticalFailingCount":{"type":"integer","format":"int32","description":"A subset of failingCount: the failing checks whose `severity` check attribute is `critical`."},"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["criticalFailingCount","failingCount","notEvaluatedCount","passingCount","warningCount"]},"DataProductInputHealthContentDTO":{"type":"object","properties":{"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["state"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductInputStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductInputTypeContentDTO":{"type":"string","enum":["dataset"]}}}} ``` ## The DataProductInputHealthContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductInputHealthContentDTO":{"type":"object","properties":{"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["state"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]}}}} ``` ## The DataProductInputStateContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductInputStateContentDTO":{"type":"string","enum":["linked","notFound"]}}}} ``` ## The DataProductInputTypeContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductInputTypeContentDTO":{"type":"string","enum":["dataset"]}}}} ``` ## The DataProductOwnerContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The DataProductOwnerStateContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]}}}} ``` ## The DataProductOwnerTypeContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductOwnerTypeContentDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The DataProductSortFieldDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataProductSortFieldDTO":{"type":"string","enum":["label","name"]}}}} ``` ## The DataQualityStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataQualityStatusDTO":{"type":"string","enum":["pass","warn","fail"]}}}} ``` ## The DataStandardActivityContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardActivityContentDTO":{"type":"object","properties":{"activeCount":{"type":"integer","format":"int32"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"datasetCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}},"required":["activeCount","checkResults","datasetCount","totalCount"]},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}}}}} ``` ## The DataStandardCheckContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardCheckContentDTO":{"type":"object","properties":{"checkType":{"type":"object","$ref":"#/components/schemas/CheckTypeDTO"},"compliance":{"type":"number"},"datasetCount":{"type":"integer","format":"int32"},"failingCount":{"type":"integer","format":"int32"},"lastScanTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"},"worstLevel":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"}}},"CheckTypeDTO":{"type":"string","enum":["missing","invalid","row_count","aggregate","schema","duplicate","freshness","failed_rows","metric","group_by","row_count_diff","aggregate_diff","freshness_diff","metric_diff","rows_diff","duplicate_diff","llm","hierarchy","fuzzy_duplicate","reference_diff","schema_diff"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]}}}} ``` ## The DataStandardCheckResultsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}}}}} ``` ## The DataStandardContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The DataStandardDatasetContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardDatasetContentDTO":{"type":"object","properties":{"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string","description":"Link to the dataset's page in Soda Cloud. That page covers the whole dataset, not only the checks of this data standard."},"id":{"type":"string"},"label":{"type":"string"},"lastScanId":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"qualifiedName":{"type":"string"}},"required":["id","name"]},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The DataStandardOwnerRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardOwnerRequestDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The DataStandardScheduleDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The DataStandardScopeAttributeFilterDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]}}}} ``` ## The DataStandardScopeAttributeFilterTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]}}}} ``` ## The DataStandardScopeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]}}}} ``` ## The DataStandardScopeMatchingDatasetContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScopeMatchingDatasetContentDTO":{"type":"object","properties":{"datasourceId":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}},"required":["datasourceId","id","name"]}}}} ``` ## The DataStandardScopeRuleDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]}}}} ``` ## The DataStandardSortFieldDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardSortFieldDTO":{"type":"string","enum":["name","label"]}}}} ``` ## The DataStandardStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The DatasetColumnProfilingContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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":"integer","format":"int64"},"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":"integer","format":"int64"},"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":"integer","format":"int64"},"value":{"type":"object","$ref":"#/components/schemas/_object"}}},"HistogramBinContentDTO":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"lowerBound":{"type":"number"},"upperBound":{"type":"number"}},"required":["count","lowerBound","upperBound"]}}}} ``` ## The DatasetComputeWarehouseConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The DatasetComputeWarehouseConfigurationDTO\_WarehouseConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetComputeWarehouseConfigurationDTO_WarehouseConfigurationDTO":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The DatasetDefaultAssignmentContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["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"]}}}} ``` ## The DatasetDefaultAssignmentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The DatasetDiagnosticsWarehouseFailedRowsConfigurationRequest object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetDiagnosticsWarehouseScanAndResultsConfigurationRequest object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetDiagnosticsWarehouseScanAndResultsConfigurationRequest":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The DatasetMetricMonitorConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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","recordAnomalyScore"]}}}} ``` ## The DatasetMonitorConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The DatasetMonitorMetricTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetMonitorMetricTypeDTO":{"type":"string","enum":["rowCount","freshness","schema","rowsInserted","totalRowCountChange","timeliness","recordAnomalyScore"]}}}} ``` ## The DatasetOwnerDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The DatasetOwnerTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The DatasetPartitionColumnContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetResponsibilityContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetResponsibilityContentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetRoleContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetSlimDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}}}}}} ``` ## The DatasetTimePartitionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasetTimePartitionTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetTimePartitionTypeDTO":{"type":"string","enum":["disabled","partitionColumn","sqlExpression"]}}}} ``` ## The DatasetsContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasetsContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checks":{"type":"integer","format":"int64","description":"Number of active checks on the dataset. Zero means the dataset is not covered by any check; checksEvaluationStatus and passingChecksPercentage are then null, while the deprecated dataQualityStatus and healthStatus still report pass and 100."},"checksEvaluationStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO","description":"Worst last result across the dataset's active checks: fail if any check failed, warn if any check warned, pass if at least one check passed and none failed or warned. Null when the dataset has no active checks or none of them has a result yet."},"cloudUrl":{"type":"string"},"contractId":{"type":"string"},"dataDelaySeconds":{"type":"integer","format":"int32"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO","deprecated":true,"description":"Deprecated: use checksEvaluationStatus instead. Same value, but a dataset with no active checks, or whose checks have never run, reads as pass here instead of null."},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"hasContract":{"type":"boolean"},"healthStatus":{"type":"integer","format":"int32","deprecated":true,"description":"Deprecated: use passingChecksPercentage instead. Same value, but a dataset with no active checks reads as 100 here instead of null."},"id":{"type":"string"},"incidents":{"type":"integer","format":"int64"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"migratedFromDatasetId":{"type":"string","description":"Id of the v3 dataset this v4 dataset was migrated from. Null for a dataset that was not migrated, and once that v3 dataset is deleted."},"migratedToDatasetId":{"type":"string","description":"Id of the v4 dataset this v3 dataset was migrated to. Null until the migration completes, and again once that v4 dataset is deleted."},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"passingChecksPercentage":{"type":"integer","format":"int32","description":"Percentage of the dataset's active checks whose last result passed, from 0 to 100. Null when the dataset has no active checks."},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}},"required":["checks","cloudUrl","hasContract","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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","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"]}}}} ``` ## The DatasourceDefaultAssignmentContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasourceDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The DatasourceDefaultAssignmentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasourceDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The DatasourcePropertiesDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The DatasourceResponsibilityContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasourceResponsibilityContentDTO":{"type":"object","properties":{"managed":{"type":"boolean"},"role":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["managed","role","type"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The DatasourceResponsibilityContentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasourceResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The DatasourceRoleContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The DiagnosticsWarehouseFailedRowsStorageStrategyDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DiagnosticsWarehouseFailedRowsStorageStrategyDTO":{"type":"string","enum":["fullFailedRows","uniqueKeys","scansAndResultsOnly"]}}}} ``` ## The DiscoveredDatasetContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DiscoveredDatasetContentDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"datasourceId":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"onboarded":{"type":"boolean"},"qualifiedName":{"type":"string"}},"required":["datasourceId","id","name","onboarded","qualifiedName"]}}}} ``` ## The DuplicateDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}}}}} ``` ## The DuplicateDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}} ``` ## The EvaluationStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]}}}} ``` ## The ExclusionZoneDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ExclusionZoneDTO":{"type":"object","properties":{"lowerLimit":{"type":"number"},"singleValue":{"type":"boolean"},"upperLimit":{"type":"number"}},"required":["lowerLimit","upperLimit"]}}}} ``` ## The ExtremeValuesContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}} ``` ## The FailedInvitationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedInvitationDTO":{"type":"object","properties":{"email":{"type":"string"},"error":{"type":"string"}}}}}} ``` ## The FailedMonitorCreationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedMonitorCreationDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"index":{"type":"integer","format":"int32","description":"Position of the entry in `monitors`, starting at 0."}},"required":["datasetId","errorCode","errorMessage","index"]}}}} ``` ## The FailedRowSamplesDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedRowSamplesDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"sampleSize":{"type":"integer","format":"int32"}}}}}} ``` ## The FailedRowsCollectionStrategyDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The FailedRowsCollectionStrategyTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedRowsCollectionStrategyTypeDTO":{"type":"string","enum":["useDefaultMaxRowCount","absolute","percentage"]}}}} ``` ## The FailedRowsConfigurationStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedRowsConfigurationStateDTO":{"type":"string","enum":["ready","doNotDetectAutomatically","awaitingPrimaryKeysInformationFromAgent","awaitingPrimaryKeysInformationFromRunner","errorMissingUniqueKeys"]}}}} ``` ## The FailedRowsDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}}}}} ``` ## The FreshnessDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}}}}} ``` ## The FreshnessDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]}}}} ``` ## The FreshnessDiffDiagnosticsV4\_UnitOfTimeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]}}}} ``` ## The FuzzyDuplicateDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}}}}} ``` ## The GenerateContractOperationStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GenerateContractOperationStateDTO":{"type":"string","enum":["ongoing","completed","failed","canceled"]}}}} ``` ## The GlobalResponsibilityContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GlobalResponsibilityContentDTO":{"type":"object","properties":{"managed":{"type":"boolean","description":"True when Soda maintains this assignment itself, for example one granted through an identity provider group. Updating the global responsibilities leaves managed assignments untouched."},"role":{"type":"object","$ref":"#/components/schemas/GlobalRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["managed","role","type"]},"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The GlobalResponsibilityContentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GlobalResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The GlobalRoleContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The GroupByColumnConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]}}}} ``` ## The GroupByColumnValueDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GroupByColumnValueDTO":{"type":"object","properties":{"columnName":{"type":"string"},"columnValue":{"type":"object","$ref":"#/components/schemas/_object","description":"The value as the data holds it: a string, a number or a boolean."}},"required":["columnName"]},"_object":{"type":"object"}}}} ``` ## The GroupByDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]}}}} ``` ## The GroupByDiagnosticsV4\_Group object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]}}}} ``` ## The GroupByDiagnosticsV4\_GroupByOutcomeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]}}}} ``` ## The HierarchyDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}}}}} ``` ## The HistogramBinContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"HistogramBinContentDTO":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"lowerBound":{"type":"number"},"upperBound":{"type":"number"}},"required":["count","lowerBound","upperBound"]}}}} ``` ## The IncidentContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"IncidentContentDTO":{"type":"object","properties":{"description":{"type":"string"},"resolutionNotes":{"type":"string"},"severity":{"type":"object","$ref":"#/components/schemas/IncidentSeverityDTO"},"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","description","id","name","number","severity","status"]},"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The IncidentSeverityDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]}}}} ``` ## The IncidentSlimDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The IncidentStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The InvalidDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}}}}} ``` ## The LlmDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}}}}} ``` ## The LogLevelDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"LogLevelDTO":{"type":"string","enum":["debug","info","warning","error"]}}}} ``` ## The LogsContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"LogsContentDTO":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"level":{"type":"object","$ref":"#/components/schemas/LogLevelDTO"},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"required":["index","level","message","timestamp"]},"LogLevelDTO":{"type":"string","enum":["debug","info","warning","error"]}}}} ``` ## The MapOfStringToMapOfStringTo\_object object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MapOfStringToMapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The MapOfStringToString object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MapOfStringToString":{"type":"object","additionalProperties":true}}}} ``` ## The MapOfStringTo\_object object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The MeasureDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MeasureDTO":{"type":"string","enum":["time"]}}}} ``` ## The MetricDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The MetricDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}}}}} ``` ## The MissingDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}}}}} ``` ## The ModelVersionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The MonitorConfigurationUpdateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorConfigurationUpdateDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","description":"Custom SQL monitors only: the columns the query result is grouped by.","items":{"type":"string"}},"groupByColumns":{"type":"array","description":"Column metric monitors only: the columns the metric is grouped by.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"resultMetric":{"type":"string","description":"Custom SQL monitors only: the name of the query result column that holds the measured value."},"sqlQuery":{"type":"string","description":"Custom SQL monitors only: the query that produces the measured value."},"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"}}}}}} ``` ## The MonitorContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorContentDTO":{"type":"object","properties":{"anomalousGroupMembersCount":{"type":"integer","format":"int32","description":"How many group members have a latest result that failed. Null outside the group parent monitor."},"columnName":{"type":"string","description":"Column the monitor watches. Null for a monitor that watches the whole dataset, and for a custom SQL monitor that has no column."},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO","description":"Outcome of the monitor's most recent result. `notEvaluated` while it has never run."},"groupByColumnValues":{"type":"array","description":"The group-by values of this group member, such as `country = BE`. Null on the group parent monitor.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnValueDTO"}},"groupByColumns":{"type":"array","description":"The columns a group-by monitor groups on. Null outside the group parent monitor.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"groupIdentity":{"type":"string","description":"Shared by the group parent monitor and its group members. Null outside group-by monitors."},"groupMembersCount":{"type":"integer","format":"int32","description":"How many group members the group-by monitor has. Null outside the group parent monitor."},"hasNotificationRules":{"type":"boolean"},"isEnabled":{"type":"boolean"},"lastDataTimestamp":{"type":"string","format":"date-time","description":"Data timestamp of the monitor's most recent result. Null while it has never run."},"metricType":{"type":"object","$ref":"#/components/schemas/MonitorMetricTypeDTO"},"monitorId":{"type":"string","description":"The id of the monitor, which the other `/api/v1/monitors` endpoints take."},"monitorName":{"type":"string"},"monitorType":{"type":"object","$ref":"#/components/schemas/MonitorTypeDTO"}},"required":["evaluationStatus","metricType","monitorId","monitorType"]},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"GroupByColumnValueDTO":{"type":"object","properties":{"columnName":{"type":"string"},"columnValue":{"type":"object","$ref":"#/components/schemas/_object","description":"The value as the data holds it: a string, a number or a boolean."}},"required":["columnName"]},"_object":{"type":"object"},"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]},"MonitorMetricTypeDTO":{"type":"string","enum":["schema","rowCount","rowsInserted","totalRowCountChange","timeliness","freshness","recordAnomalyScore","average","missingPercentage","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3","customSql"]},"MonitorTypeDTO":{"type":"string","enum":["dataset","column","customSql"]}}}} ``` ## The MonitorExpectedRangeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorExpectedRangeDTO":{"type":"object","properties":{"lower":{"type":"number"},"upper":{"type":"number"}}}}}} ``` ## The MonitorMetricTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorMetricTypeDTO":{"type":"string","enum":["schema","rowCount","rowsInserted","totalRowCountChange","timeliness","freshness","recordAnomalyScore","average","missingPercentage","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3","customSql"]}}}} ``` ## The MonitorResultContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorResultContentDTO":{"type":"object","properties":{"dataTimestamp":{"type":"string","format":"date-time","description":"The moment in the data the result is about, which `from` and `to` filter on."},"diagnostics":{"type":"object","$ref":"#/components/schemas/MonitorResultDiagnosticsDTO","description":"What one type of monitor adds to its result, with one key per type. Only the key of this monitor's type is set. Null when the monitor's type adds nothing."},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"expectedRange":{"type":"object","$ref":"#/components/schemas/MonitorExpectedRangeDTO","description":"The range the value had to fall in to pass, bounds included. A null bound means the value could not fail on that side. Null when the monitor did not evaluate the value, or could not fail on either side."},"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO"},"id":{"type":"string"},"incident":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"},"monitorId":{"type":"string"},"predictedValue":{"type":"number"},"scanId":{"type":"string"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced the result ran."},"value":{"type":"number","description":"The measured metric. For record anomaly detection, the anomaly score from 0 to 1."}},"required":["dataTimestamp","evaluationStatus","id","monitorId"]},"MonitorResultDiagnosticsDTO":{"type":"object","properties":{"recordAnomalyDetection":{"type":"object","$ref":"#/components/schemas/RecordAnomalyDetectionDiagnosticsDTO"}}},"RecordAnomalyDetectionDiagnosticsDTO":{"type":"object","properties":{"explanation":{"type":"object","$ref":"#/components/schemas/RadExplanationDTO","description":"Why the partition looked unusual. Null when the run produced no explanation."},"monitoredColumns":{"type":"array","description":"The columns this run compared. Empty when it compared none, as on a run without a score.","items":{"type":"string"}},"partition":{"type":"object","$ref":"#/components/schemas/RadPartitionDTO"},"reference":{"type":"object","$ref":"#/components/schemas/RadReferencePartitionDTO","description":"The past partition that looked most like this one. The explanation compares against it. Null when no past partition was selected, as on a `skipped` run."},"runPhase":{"type":"object","$ref":"#/components/schemas/RadRunPhaseDTO","description":"`skipped`: the run produced no score, for example because the partition was empty, had too few rows, or had too few past partitions to compare with. `warmingUp`: fewer past partitions are available than the full window, so a score is less settled. `steady`: the full window of past partitions is available."}},"required":["monitoredColumns","partition","runPhase"]},"RadExplanationDTO":{"type":"object","properties":{"columnEffects":{"type":"array","description":"Columns whose values shifted across the whole partition. Empty when no column stood out.","items":{"type":"object","$ref":"#/components/schemas/RadColumnEffectDTO"}},"segmentEffects":{"type":"array","description":"Columns whose values shifted more within a slice of rows than across the whole partition. Empty when no slice stood out.","items":{"type":"object","$ref":"#/components/schemas/RadSegmentEffectDTO"}}},"required":["columnEffects","segmentEffects"]},"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]},"RadPartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"rowCount":{"type":"integer","format":"int32","description":"Rows in the whole partition, not in the sample the bucket counts are taken from. 0 means the partition was empty."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadReferencePartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadRunPhaseDTO":{"type":"string","enum":["skipped","warmingUp","steady"]},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"MonitorExpectedRangeDTO":{"type":"object","properties":{"lower":{"type":"number"},"upper":{"type":"number"}}},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The MonitorResultDiagnosticsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorResultDiagnosticsDTO":{"type":"object","properties":{"recordAnomalyDetection":{"type":"object","$ref":"#/components/schemas/RecordAnomalyDetectionDiagnosticsDTO"}}},"RecordAnomalyDetectionDiagnosticsDTO":{"type":"object","properties":{"explanation":{"type":"object","$ref":"#/components/schemas/RadExplanationDTO","description":"Why the partition looked unusual. Null when the run produced no explanation."},"monitoredColumns":{"type":"array","description":"The columns this run compared. Empty when it compared none, as on a run without a score.","items":{"type":"string"}},"partition":{"type":"object","$ref":"#/components/schemas/RadPartitionDTO"},"reference":{"type":"object","$ref":"#/components/schemas/RadReferencePartitionDTO","description":"The past partition that looked most like this one. The explanation compares against it. Null when no past partition was selected, as on a `skipped` run."},"runPhase":{"type":"object","$ref":"#/components/schemas/RadRunPhaseDTO","description":"`skipped`: the run produced no score, for example because the partition was empty, had too few rows, or had too few past partitions to compare with. `warmingUp`: fewer past partitions are available than the full window, so a score is less settled. `steady`: the full window of past partitions is available."}},"required":["monitoredColumns","partition","runPhase"]},"RadExplanationDTO":{"type":"object","properties":{"columnEffects":{"type":"array","description":"Columns whose values shifted across the whole partition. Empty when no column stood out.","items":{"type":"object","$ref":"#/components/schemas/RadColumnEffectDTO"}},"segmentEffects":{"type":"array","description":"Columns whose values shifted more within a slice of rows than across the whole partition. Empty when no slice stood out.","items":{"type":"object","$ref":"#/components/schemas/RadSegmentEffectDTO"}}},"required":["columnEffects","segmentEffects"]},"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]},"RadPartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"rowCount":{"type":"integer","format":"int32","description":"Rows in the whole partition, not in the sample the bucket counts are taken from. 0 means the partition was empty."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadReferencePartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadRunPhaseDTO":{"type":"string","enum":["skipped","warmingUp","steady"]}}}} ``` ## The MonitorResultFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}}}}} ``` ## The MonitorTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"MonitorTypeDTO":{"type":"string","enum":["dataset","column","customSql"]}}}} ``` ## The NotificationCustomizationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationCustomizationDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationTypeDTO"}},"required":["type"]},"NotificationCustomizationTypeDTO":{"type":"string","enum":["rich","minimal","matchedChecks"]}}}} ``` ## The NotificationCustomizationTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationCustomizationTypeDTO":{"type":"string","enum":["rich","minimal","matchedChecks"]}}}} ``` ## The NotificationFilterDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationFilterDTO":{"type":"object","properties":{"caseInsensitive":{"type":"boolean"},"expression":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"expressions":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"}},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationFilterTypeDTO"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["type"]},"NotificationFilterFieldDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldTypeDTO"}},"required":["field"]},"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]},"NotificationFilterTypeDTO":{"type":"string","enum":["equals","contains","in","and","or","not"]}}}} ``` ## The NotificationFilterFieldDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationFilterFieldDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldTypeDTO"}},"required":["field"]},"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]}}}} ``` ## The NotificationFilterFieldTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]}}}} ``` ## The NotificationFilterTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationFilterTypeDTO":{"type":"string","enum":["equals","contains","in","and","or","not"]}}}} ``` ## The NotificationIntegrationStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationIntegrationStatusDTO":{"type":"string","enum":["enabled","disabled"]}}}} ``` ## The NotificationIntegrationTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationIntegrationTypeDTO":{"type":"string","enum":["slack","microsoftTeams","webhook"]}}}} ``` ## The NotificationLevelDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]}}}} ``` ## The NotificationRecipientDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationRecipientDTO":{"type":"object","properties":{"customRoleId":{"type":"string"},"email":{"type":"string"},"integrationChannel":{"type":"string"},"integrationId":{"type":"string"},"role":{"type":"object","$ref":"#/components/schemas/NotificationRecipientRoleDTO"},"triggers":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTriggerDTO"}},"type":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["triggers","type"]},"NotificationRecipientRoleDTO":{"type":"string","enum":["datasetOwner","monitorOwner"]},"NotificationRecipientTriggerDTO":{"type":"object","properties":{"level":{"type":"object","$ref":"#/components/schemas/NotificationLevelDTO"},"scanState":{"type":"object","$ref":"#/components/schemas/NotificationScanStateDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationTriggerTypeDTO"}},"required":["type"]},"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]},"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]},"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]},"NotificationRecipientTypeDTO":{"type":"string","enum":["email","user","userGroup","integration","resourceRole","customRole"]}}}} ``` ## The NotificationRecipientRoleDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationRecipientRoleDTO":{"type":"string","enum":["datasetOwner","monitorOwner"]}}}} ``` ## The NotificationRecipientTriggerDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationRecipientTriggerDTO":{"type":"object","properties":{"level":{"type":"object","$ref":"#/components/schemas/NotificationLevelDTO"},"scanState":{"type":"object","$ref":"#/components/schemas/NotificationScanStateDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationTriggerTypeDTO"}},"required":["type"]},"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]},"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]},"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]}}}} ``` ## The NotificationRecipientTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationRecipientTypeDTO":{"type":"string","enum":["email","user","userGroup","integration","resourceRole","customRole"]}}}} ``` ## The NotificationRuleStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationRuleStatusDTO":{"type":"string","enum":["active","paused"]}}}} ``` ## The NotificationScanStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]}}}} ``` ## The NotificationTriggerTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]}}}} ``` ## The OwnerDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"OwnerDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"}}}}}} ``` ## The ProfilingSamplingStrategyConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The PublicApiBlastRadiusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiBlastRadiusDTO":{"type":"object","properties":{"assetType":{"type":"object","$ref":"#/components/schemas/RcaAssetTypeDTO"},"count":{"type":"integer","format":"int32"}}},"RcaAssetTypeDTO":{"type":"string","enum":["dataset","datasource"]}}}} ``` ## The PublicApiBulkCreateMonitorsRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiBulkCreateMonitorsRequestDTO":{"type":"object","properties":{"monitors":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiCreateMonitorRequestDTO"}}},"required":["monitors"]},"PublicApiCreateMonitorRequestDTO":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/CreateColumnMetricMonitorDTO","description":"Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."},"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CreateCustomSqlMonitorDTO","description":"Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."},"datasetId":{"type":"string"},"datasetMetricMonitor":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO","description":"The dataset metric monitor to create, such as row count or freshness; a dataset has one per metric type. Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."}},"required":["datasetId"]},"CreateColumnMetricMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["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"]},"CreateCustomSqlMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string","description":"Optional column to associate with the monitor. If not specified, the monitor is associated with the full dataset. This is metadata only, it does not affect how the monitor operates."},"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"]},"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","recordAnomalyScore"]}}}} ``` ## The PublicApiBulkCreateMonitorsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiBulkCreateMonitorsResponse":{"type":"object","properties":{"createdMonitors":{"type":"array","description":"The monitors that were created, in the order of the request.","items":{"type":"object","$ref":"#/components/schemas/PublicApiMonitorResponse"}},"failedMonitors":{"type":"array","description":"The entries that could not be created, with their position in `monitors`.","items":{"type":"object","$ref":"#/components/schemas/FailedMonitorCreationDTO"}}},"required":["createdMonitors","failedMonitors"]},"PublicApiMonitorResponse":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO","description":"Set when the monitor is a column metric monitor."},"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO","description":"Set when the monitor is a custom SQL monitor."},"datasetId":{"type":"string"},"datasetMetricMonitor":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO","description":"Set when the monitor is a dataset metric monitor."},"monitorId":{"type":"string","description":"The id of the monitor. Column and custom SQL monitor objects repeat it as `checkId`."}},"required":["datasetId","monitorId"]},"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","recordAnomalyScore"]},"FailedMonitorCreationDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"errorCode":{"type":"string"},"errorMessage":{"type":"string"},"index":{"type":"integer","format":"int32","description":"Position of the entry in `monitors`, starting at 0."}},"required":["datasetId","errorCode","errorMessage","index"]}}}} ``` ## The PublicApiBulkSubmitMonitorResultFeedbackResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiBulkSubmitMonitorResultFeedbackResponse":{"type":"object","properties":{"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO","description":"The feedback as it is now stored on every one of them, including `submittedAt`, when Soda Cloud stored it."},"resultIds":{"type":"array","description":"The monitor results that now carry the feedback, each once, in the order they were requested.","items":{"type":"string"}}},"required":["feedback","resultIds"]},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}}}}} ``` ## The PublicApiCheckResultsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCheckResultsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultContentDTO"}},"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"]},"CheckResultContentDTO":{"type":"object","properties":{"anomalyDetectionDetails":{"type":"object","$ref":"#/components/schemas/CheckResultAnomalyDetectionDetailsDTO","deprecated":true},"checkId":{"type":"string"},"dataTimestamp":{"type":"string","format":"date-time"},"diagnostics":{"type":"object","$ref":"#/components/schemas/CheckResultDiagnosticsV4"},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO","description":"Feedback given on this result. Only anomaly detection results carry it."},"id":{"type":"string"},"incident":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"},"measure":{"type":"object","$ref":"#/components/schemas/MeasureDTO"},"scanId":{"type":"string"},"scanTime":{"type":"string","format":"date-time"},"value":{"type":"number"},"valueLabel":{"type":"string"},"valueSeries":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO"}},"required":["checkId","dataTimestamp","evaluationStatus","id"]},"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}},"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]},"MeasureDTO":{"type":"string","enum":["time"]},"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}}}}} ``` ## The PublicApiCheckSlimDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCheckSlimDTO":{"type":"object","properties":{"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"id":{"type":"string"},"source":{"type":"object","$ref":"#/components/schemas/CheckSourceDTO","description":"Where the check was defined. Null for checks whose source is not known to Soda Cloud."}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"CheckSourceDTO":{"type":"string","enum":["soda-sql","soda-core","soda-library","soda-cloud","dbt","soda-contract","data-standard","soda-metric-monitoring"]}}}} ``` ## The PublicApiChecksResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiChecksResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ChecksContentDTO"}},"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"]},"ChecksContentDTO":{"type":"object","properties":{"agreements":{"type":"array","deprecated":true,"items":{"type":"object","$ref":"#/components/schemas/AgreementSlimDTO"}},"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringToString"},"checkType":{"type":"string"},"cloudUrl":{"type":"string"},"column":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetSlimDTO"}},"definition":{"type":"string","description":"The check as the runner last sent it. For checks whose `source` is `soda-contract` or `data-standard`: a YAML fragment of the contract or data standard with only this check in it, under its check type key. Older runners leave out the check type key and the `reconciliation` block, so use `checkType`. For other sources: the check text, such as SodaCL."},"description":{"type":"string"},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"group":{"type":"object","$ref":"#/components/schemas/ChecksContentDTO_Group"},"id":{"type":"string"},"incidents":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"}},"lastCheckResultValue":{"type":"object","$ref":"#/components/schemas/CheckResultValueDTO"},"lastCheckRunTime":{"type":"string","format":"date-time","deprecated":true},"lastUpdated":{"type":"string","format":"date-time","deprecated":true},"metricType":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/OwnerDTO","deprecated":true},"source":{"type":"object","$ref":"#/components/schemas/CheckSourceDTO","description":"Where the check was defined. Null for checks whose source is not known to Soda Cloud."}},"required":["createdAt","datasets","evaluationStatus","id","incidents","name"]},"AgreementSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"name":{"type":"string"}}},"MapOfStringToString":{"type":"object","additionalProperties":true},"DatasetSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"ChecksContentDTO_Group":{"type":"object","properties":{"groupType":{"type":"string"},"identity":{"type":"string"},"name":{"type":"string"}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]},"CheckResultValueDTO":{"type":"object","properties":{"anomalyDetectionDetails":{"type":"object","$ref":"#/components/schemas/CheckResultAnomalyDetectionDetailsDTO","deprecated":true},"dataTimestamp":{"type":"string","format":"date-time"},"diagnostics":{"type":"object","$ref":"#/components/schemas/CheckResultDiagnosticsV4"},"id":{"type":"string"},"measure":{"type":"object","$ref":"#/components/schemas/MeasureDTO"},"value":{"type":"number"},"valueLabel":{"type":"string"},"valueSeries":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO"}},"required":["id"]},"CheckResultAnomalyDetectionDetailsDTO":{"type":"object","properties":{"predictedValue":{"type":"number"}}},"CheckResultDiagnosticsV4":{"type":"object","properties":{"aggregate":{"type":"object","$ref":"#/components/schemas/AggregateDiagnosticsV4"},"aggregate_diff":{"type":"object","$ref":"#/components/schemas/AggregateDiffDiagnosticsV4"},"duplicate":{"type":"object","$ref":"#/components/schemas/DuplicateDiagnosticsV4"},"duplicate_diff":{"type":"object","$ref":"#/components/schemas/DuplicateDiffDiagnosticsV4"},"failed_rows":{"type":"object","$ref":"#/components/schemas/FailedRowsDiagnosticsV4"},"freshness":{"type":"object","$ref":"#/components/schemas/FreshnessDiagnosticsV4"},"freshness_diff":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4"},"fuzzy_duplicate":{"type":"object","$ref":"#/components/schemas/FuzzyDuplicateDiagnosticsV4"},"group_by":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4"},"hierarchy":{"type":"object","$ref":"#/components/schemas/HierarchyDiagnosticsV4"},"invalid":{"type":"object","$ref":"#/components/schemas/InvalidDiagnosticsV4"},"llm":{"type":"object","$ref":"#/components/schemas/LlmDiagnosticsV4"},"metric":{"type":"object","$ref":"#/components/schemas/MetricDiagnosticsV4"},"metric_diff":{"type":"object","$ref":"#/components/schemas/MetricDiffDiagnosticsV4"},"missing":{"type":"object","$ref":"#/components/schemas/MissingDiagnosticsV4"},"reference_diff":{"type":"object","$ref":"#/components/schemas/ReferenceDiffDiagnosticsV4"},"row_count":{"type":"object","$ref":"#/components/schemas/RowCountDiagnosticsV4"},"row_count_diff":{"type":"object","$ref":"#/components/schemas/RowCountDiffDiagnosticsV4"},"rows_diff":{"type":"object","$ref":"#/components/schemas/RowsDiffDiagnosticsV4"},"schema":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4"},"schema_diff":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4"}}},"AggregateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"AggregateDiffDiagnosticsV4":{"type":"object","properties":{"diff":{"type":"number"},"diffPercent":{"type":"number"},"function":{"type":"string"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceValue":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetValue":{"type":"number"}}},"DuplicateDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"DuplicateDiffDiagnosticsV4":{"type":"object","properties":{"duplicateCountDiff":{"type":"integer","format":"int32"},"duplicateDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceDuplicateCount":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetDuplicateCount":{"type":"integer","format":"int32"}}},"FailedRowsDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"FreshnessDiagnosticsV4":{"type":"object","properties":{"actualTimestamp":{"type":"string","format":"date-time"},"actualTimestampUtc":{"type":"string","format":"date-time"},"datasetRowsTested":{"type":"integer","format":"int32"},"expectedTimestamp":{"type":"string","format":"date-time"},"expectedTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4":{"type":"object","properties":{"freshnessDiff":{"type":"integer","format":"int32"},"freshnessDiffUnit":{"type":"object","$ref":"#/components/schemas/FreshnessDiffDiagnosticsV4_UnitOfTimeDTO"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMaxTimestamp":{"type":"string","format":"date-time"},"sourceMaxTimestampUtc":{"type":"string","format":"date-time"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMaxTimestamp":{"type":"string","format":"date-time"},"targetMaxTimestampUtc":{"type":"string","format":"date-time"}}},"FreshnessDiffDiagnosticsV4_UnitOfTimeDTO":{"type":"string","enum":["minutes","hours","days"]},"FuzzyDuplicateDiagnosticsV4":{"type":"object","properties":{"candidateRowsScored":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"clusterCount":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"fuzzyDuplicateCount":{"type":"integer","format":"int32"},"fuzzyDuplicatePercent":{"type":"number"},"meanConfidence":{"type":"number"}}},"GroupByDiagnosticsV4":{"type":"object","properties":{"diagnosticsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"groups":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_Group"}}}},"GroupByDiagnosticsV4_Group":{"type":"object","properties":{"group":{"type":"string"},"rowsTested":{"type":"integer","format":"int64"},"status":{"type":"object","$ref":"#/components/schemas/GroupByDiagnosticsV4_GroupByOutcomeDTO"},"value":{"type":"number"}}},"GroupByDiagnosticsV4_GroupByOutcomeDTO":{"type":"string","enum":["pass","warn","fail"]},"HierarchyDiagnosticsV4":{"type":"object","properties":{"brokenPathCount":{"type":"integer","format":"int32"},"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"invalidValueCount":{"type":"integer","format":"int32"},"missingValueCount":{"type":"integer","format":"int32"}}},"InvalidDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"},"missingCount":{"type":"integer","format":"int32"}}},"LlmDiagnosticsV4":{"type":"object","properties":{"completionTokens":{"type":"integer","format":"int64"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsSourceQuery":{"type":"string"},"model":{"type":"string"},"promptTokens":{"type":"integer","format":"int64"},"rowsChecked":{"type":"integer","format":"int32"},"rowsFailed":{"type":"integer","format":"int32"},"rowsFailedPercent":{"type":"number"},"tokensSpent":{"type":"integer","format":"int32"}}},"MetricDiagnosticsV4":{"type":"object","properties":{"datasetRowsTested":{"type":"integer","format":"int32"}}},"MetricDiffDiagnosticsV4":{"type":"object","properties":{"metricDiff":{"type":"number"},"metricDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"sourceMetric":{"type":"number"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"},"targetMetric":{"type":"number"}}},"MissingDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"},"failedRowsCount":{"type":"integer","format":"int32"},"failedRowsDataQuery":{"type":"string"},"failedRowsKeysQuery":{"type":"string"},"failedRowsPercent":{"type":"number"},"failedRowsSourceQuery":{"type":"string"}}},"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}},"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}},"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}},"MeasureDTO":{"type":"string","enum":["time"]},"CheckResultValueSeriesDTO":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/CheckResultValueSeriesDTO_ValueSeriesValue"}}}},"CheckResultValueSeriesDTO_ValueSeriesValue":{"type":"object","properties":{"label":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"value":{"type":"number"}}},"OwnerDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"}}},"CheckSourceDTO":{"type":"string","enum":["soda-sql","soda-core","soda-library","soda-cloud","dbt","soda-contract","data-standard","soda-metric-monitoring"]}}}} ``` ## The PublicApiContractCheckFilterDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiContractCheckFilterDTO":{"type":"object","properties":{"field":{"type":"object","$ref":"#/components/schemas/PublicApiContractCheckFilterFieldDTO"},"negate":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}}},"PublicApiContractCheckFilterFieldDTO":{"type":"string","enum":["scope"]}}}} ``` ## The PublicApiContractCheckFilterFieldDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiContractCheckFilterFieldDTO":{"type":"string","enum":["scope"]}}}} ``` ## The PublicApiCreateAttributeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateAttributeRequestDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"resourceType":{"type":"object","$ref":"#/components/schemas/AttributeResourceTypeDTO"},"type":{"type":"object","$ref":"#/components/schemas/AttributeTypeDTO"}},"required":["label","name","resourceType","type"]},"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]},"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The PublicApiCreateAttributeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateAttributeResponse":{"type":"object","properties":{"attribute":{"type":"object","$ref":"#/components/schemas/AttributeContentDTO"}},"required":["attribute"]},"AttributeContentDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"resourceType":{"type":"object","$ref":"#/components/schemas/AttributeResourceTypeDTO"},"type":{"type":"object","$ref":"#/components/schemas/AttributeTypeDTO"}},"required":["id","label","name","resourceType","type"]},"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]},"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The PublicApiCreateColumnMetricMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The PublicApiCreateColumnMetricMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The PublicApiCreateContractChangeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateContractChangeRequestDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"reasoning":{"type":"string"},"title":{"type":"string"}},"required":["title"]}}}} ``` ## The PublicApiCreateContractChangeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateContractChangeResponse":{"type":"object","properties":{"contractRequest":{"type":"object","$ref":"#/components/schemas/ContractChangeRequestDTO"}}},"ContractChangeRequestDTO":{"type":"object","properties":{"authorId":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/ContractChangeRequestStatusDTO"},"title":{"type":"string"}}},"ContractChangeRequestStatusDTO":{"type":"string","enum":["open","wontDo","done","draft","ready","waiting","inReview"]}}}} ``` ## The PublicApiCreateContractRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateContractRequestDTO":{"type":"object","properties":{"contents":{"type":"string"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"}},"required":["contents"]}}}} ``` ## The PublicApiCreateContractResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateContractResponse":{"type":"object","properties":{"contract":{"type":"object","$ref":"#/components/schemas/ContractContentDTO"}}},"ContractContentDTO":{"type":"object","properties":{"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiCreateCustomSqlMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"}}}}}} ``` ## The PublicApiCreateCustomSqlMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateCustomSqlMonitorResponse":{"type":"object","properties":{"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO"},"customSqlMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO","deprecated":true}},"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"]},"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"}}}}}} ``` ## The PublicApiCreateDataProductResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"},"warnings":{"type":"array","items":{"type":"string"}}},"required":["dataProduct","warnings"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The `key` of the data product YAML. It is unique in the organization and cannot change. Use it as `dataProductName` in the paths."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The PublicApiCreateDataStandardResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateDataStandardResponse":{"type":"object","properties":{"dataStandard":{"type":"object","$ref":"#/components/schemas/DataStandardContentDTO"}}},"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiCreateDatasetRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The PublicApiCreateDatasourceRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateDatasourceRequestDTO":{"type":"object","properties":{"configurationFileContents":{"type":"string"},"label":{"type":"string"},"ownerId":{"type":"string"},"runnerId":{"type":"string"}},"required":["configurationFileContents"]}}}} ``` ## The PublicApiCreateDatasourceResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateDatasourceResponse":{"type":"object","properties":{"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDTO"},"discoveryScanId":{"type":"string"}}},"PublicApiDatasourceDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceTypeDTO"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO","description":"The Soda model version of the datasource: `3` or `4`."}}},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]},"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The PublicApiCreateDatasourceRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateDatasourceRoleResponse":{"type":"object","properties":{"datasourceRole":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"}},"required":["datasourceRole"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The PublicApiCreateGlobalRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateGlobalRoleResponse":{"type":"object","properties":{"globalRole":{"type":"object","$ref":"#/components/schemas/GlobalRoleContentDTO"}},"required":["globalRole"]},"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiCreateIncidentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateIncidentDTO":{"type":"object","properties":{"description":{"type":"string"},"leadId":{"type":"string"},"monitorResultIds":{"type":"array","items":{"type":"string"}},"resolutionNotes":{"type":"string"},"severity":{"type":"object","$ref":"#/components/schemas/IncidentSeverityDTO"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"},"title":{"type":"string"}},"required":["description","monitorResultIds","severity","title"]},"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The PublicApiCreateMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateMonitorRequestDTO":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/CreateColumnMetricMonitorDTO","description":"Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."},"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CreateCustomSqlMonitorDTO","description":"Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."},"datasetId":{"type":"string"},"datasetMetricMonitor":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO","description":"The dataset metric monitor to create, such as row count or freshness; a dataset has one per metric type. Send exactly one of `datasetMetricMonitor`, `columnMetricMonitor` or `customSqlMetricMonitor`."}},"required":["datasetId"]},"CreateColumnMetricMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string"},"configuration":{"type":"object","$ref":"#/components/schemas/ColumnMonitorConfigurationDTO"},"metricType":{"type":"object","$ref":"#/components/schemas/ColumnMonitorMetricTypeDTO"}},"required":["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"]},"CreateCustomSqlMonitorDTO":{"type":"object","properties":{"columnName":{"type":"string","description":"Optional column to associate with the monitor. If not specified, the monitor is associated with the full dataset. This is metadata only, it does not affect how the monitor operates."},"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"]},"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","recordAnomalyScore"]}}}} ``` ## The PublicApiCreateRunnerResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateRunnerResponse":{"type":"object","properties":{"apiKeyId":{"type":"string"},"apiKeySecret":{"type":"string"}}}}}} ``` ## The PublicApiCreateSecretRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateSecretRequestDTO":{"type":"object","properties":{"encryptedValue":{"type":"string"},"encryptionKey":{"type":"string"},"name":{"type":"string"}},"required":["encryptedValue","encryptionKey","name"]}}}} ``` ## The PublicApiCreateSecretResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateSecretResponse":{"type":"object","properties":{"secret":{"type":"object","$ref":"#/components/schemas/PublicApiSecretDTO"}}},"PublicApiSecretDTO":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}} ``` ## The PublicApiCreateSkeletonContractRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateSkeletonContractRequestDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"}}}}}} ``` ## The PublicApiCreateSkeletonContractStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateSkeletonContractStatusResponse":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"operationId":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/SkeletonContractOperationStateDTO"}}},"SkeletonContractOperationStateDTO":{"type":"string","enum":["ongoing","completed","failed","canceled"]}}}} ``` ## The PublicApiCreateUserGroupRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiCreateUserGroupRequestDTO":{"type":"object","properties":{"name":{"type":"string"},"userIds":{"type":"array","items":{"type":"string"}}},"required":["name"]}}}} ``` ## The PublicApiDataProductRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDataProductRequestDTO":{"type":"object","properties":{"contents":{"type":"string"}},"required":["contents"]}}}} ``` ## The PublicApiDataStandardRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDataStandardRequestDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"contents":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardOwnerRequestDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["contents","name","owners","status"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardOwnerRequestDTO":{"type":"object","properties":{"type":{"type":"object","$ref":"#/components/schemas/DatasetOwnerTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["type"]},"DatasetOwnerTypeDTO":{"type":"string","enum":["user","userGroup"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiDataStandardsActivityResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDataStandardsActivityResponse":{"type":"object","properties":{"activity":{"type":"object","$ref":"#/components/schemas/DataStandardActivityContentDTO"}}},"DataStandardActivityContentDTO":{"type":"object","properties":{"activeCount":{"type":"integer","format":"int32"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"datasetCount":{"type":"integer","format":"int32"},"totalCount":{"type":"integer","format":"int32"}},"required":["activeCount","checkResults","datasetCount","totalCount"]},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}}}}} ``` ## The PublicApiDatasetColumnContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetColumnContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"columnId":{"type":"string"},"columnName":{"type":"string"}},"required":["attributes","columnId","columnName"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The PublicApiDatasetDefaultResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetDefaultResponsibilitiesResponse":{"type":"object","properties":{"assignments":{"type":"array","description":"Users and user groups that are granted a dataset role on every newly created dataset.","items":{"type":"object","$ref":"#/components/schemas/DatasetDefaultAssignmentContentDTO"}},"defaultOwnerRole":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO","description":"Dataset role granted to the owner of a newly created dataset. Null when no role is configured."}},"required":["assignments"]},"DatasetDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/DatasetRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["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"]}}}} ``` ## The PublicApiDatasetDiagnosticsWarehouseResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetDiagnosticsWarehouseResponse":{"type":"object","properties":{"effectiveConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveConfigurationDTO","description":"What applies to this dataset once the settings of its datasource are merged in. Read-only: `POST /api/v1/datasets/{datasetId}` ignores it."},"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseFailedRowsConfigurationDTO"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO"},"schema":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveConfigurationDTO":{"type":"object","properties":{"datasourceId":{"type":"string"},"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveFailedRowsConfigurationDTO"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO"},"schema":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveFailedRowsConfigurationDTO":{"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"},"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"]},"PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"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"}}}},"FailedRowsConfigurationStateDTO":{"type":"string","enum":["ready","doNotDetectAutomatically","awaitingPrimaryKeysInformationFromAgent","awaitingPrimaryKeysInformationFromRunner","errorMissingUniqueKeys"]}}}} ``` ## The PublicApiDatasetDiagnosticsWarehouseResponse\_DiagnosticsWarehouseFailedRowsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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","awaitingPrimaryKeysInformationFromRunner","errorMissingUniqueKeys"]},"DiagnosticsWarehouseFailedRowsStorageStrategyDTO":{"type":"string","enum":["fullFailedRows","uniqueKeys","scansAndResultsOnly"]}}}} ``` ## The PublicApiDatasetDiagnosticsWarehouseResponse\_DiagnosticsWarehouseScanAndResultsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiDatasetDiagnosticsWarehouseResponse\_EffectiveConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveConfigurationDTO":{"type":"object","properties":{"datasourceId":{"type":"string"},"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveFailedRowsConfigurationDTO"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO"},"schema":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveFailedRowsConfigurationDTO":{"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"},"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"]},"PublicApiDatasetDiagnosticsWarehouseResponse_DiagnosticsWarehouseScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiDatasetDiagnosticsWarehouseResponse\_EffectiveFailedRowsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetDiagnosticsWarehouseResponse_EffectiveFailedRowsConfigurationDTO":{"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"},"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"]}}}} ``` ## The PublicApiDatasetMetricMonitoringResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"}},"dataDelaySeconds":{"type":"integer","format":"int32"},"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","recordAnomalyScore"]},"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"]}}}} ``` ## The PublicApiDatasetMetricMonitoringUpdateStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetMetricMonitoringUpdateStatusDTO":{"type":"string","enum":["applied","skipped","failed"]}}}} ``` ## The PublicApiDatasetProfilingResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasetProfilingResponse":{"type":"object","properties":{"columnCount":{"type":"integer","format":"int64"},"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":"integer","format":"int64"},"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":"integer","format":"int64"},"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":"integer","format":"int64"},"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":"integer","format":"int64"},"value":{"type":"object","$ref":"#/components/schemas/_object"}}},"HistogramBinContentDTO":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"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"]}}}} ``` ## The PublicApiDatasetResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The PublicApiDatasetRoleRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The PublicApiDatasetRolesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The PublicApiDatasetsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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":"integer","format":"int64","description":"Number of active checks on the dataset. Zero means the dataset is not covered by any check; checksEvaluationStatus and passingChecksPercentage are then null, while the deprecated dataQualityStatus and healthStatus still report pass and 100."},"checksEvaluationStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO","description":"Worst last result across the dataset's active checks: fail if any check failed, warn if any check warned, pass if at least one check passed and none failed or warned. Null when the dataset has no active checks or none of them has a result yet."},"cloudUrl":{"type":"string"},"contractId":{"type":"string"},"dataDelaySeconds":{"type":"integer","format":"int32"},"dataQualityStatus":{"type":"object","$ref":"#/components/schemas/DataQualityStatusDTO","deprecated":true,"description":"Deprecated: use checksEvaluationStatus instead. Same value, but a dataset with no active checks, or whose checks have never run, reads as pass here instead of null."},"datasetQualifiedName":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/DatasourcePropertiesDTO"},"hasContract":{"type":"boolean"},"healthStatus":{"type":"integer","format":"int32","deprecated":true,"description":"Deprecated: use passingChecksPercentage instead. Same value, but a dataset with no active checks reads as 100 here instead of null."},"id":{"type":"string"},"incidents":{"type":"integer","format":"int64"},"label":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"migratedFromDatasetId":{"type":"string","description":"Id of the v3 dataset this v4 dataset was migrated from. Null for a dataset that was not migrated, and once that v3 dataset is deleted."},"migratedToDatasetId":{"type":"string","description":"Id of the v4 dataset this v3 dataset was migrated to. Null until the migration completes, and again once that v4 dataset is deleted."},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"partitionColumn":{"type":"object","$ref":"#/components/schemas/DatasetPartitionColumnContentDTO","deprecated":true},"passingChecksPercentage":{"type":"integer","format":"int32","description":"Percentage of the dataset's active checks whose last result passed, from 0 to 100. Null when the dataset has no active checks."},"qualifiedName":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO"}},"required":["checks","cloudUrl","hasContract","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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","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"]}}}} ``` ## The PublicApiDatasourceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceTypeDTO"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO","description":"The Soda model version of the datasource: `3` or `4`."}}},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]},"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The PublicApiDatasourceDefaultResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDefaultResponsibilitiesResponse":{"type":"object","properties":{"assignments":{"type":"array","description":"Users and user groups that are granted a datasource role on every newly created datasource.","items":{"type":"object","$ref":"#/components/schemas/DatasourceDefaultAssignmentContentDTO"}},"defaultOwnerRole":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO","description":"Datasource role granted to the owner of a newly created datasource. Null when no role is configured."}},"required":["assignments"]},"DatasourceDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The PublicApiDatasourceDiagnosticsWarehouseResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDiagnosticsWarehouseResponse":{"type":"object","properties":{"enabled":{"type":"boolean"},"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDiagnosticsWarehouseResponse_FailedRowsConfigurationDTO"},"reuseDatasource":{"type":"boolean"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDiagnosticsWarehouseResponse_ScanAndResultsConfigurationDTO"},"schema":{"oneOf":[{"type":"string"},{"type":"null"}]},"tableNameTemplate":{"type":"string"}}},"PublicApiDatasourceDiagnosticsWarehouseResponse_FailedRowsConfigurationDTO":{"type":"object","properties":{"actionButton":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDiagnosticsWarehouseResponse_ActionButtonDTO"},"enabled":{"type":"boolean"},"exposeQueries":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"locationMessage":{"type":"string"},"maxRowCount":{"type":"integer","format":"int32"}}},"PublicApiDatasourceDiagnosticsWarehouseResponse_ActionButtonDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"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"]},"PublicApiDatasourceDiagnosticsWarehouseResponse_ScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiDatasourceDiagnosticsWarehouseResponse\_ActionButtonDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDiagnosticsWarehouseResponse_ActionButtonDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The PublicApiDatasourceDiagnosticsWarehouseResponse\_FailedRowsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDiagnosticsWarehouseResponse_FailedRowsConfigurationDTO":{"type":"object","properties":{"actionButton":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDiagnosticsWarehouseResponse_ActionButtonDTO"},"enabled":{"type":"boolean"},"exposeQueries":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"locationMessage":{"type":"string"},"maxRowCount":{"type":"integer","format":"int32"}}},"PublicApiDatasourceDiagnosticsWarehouseResponse_ActionButtonDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"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"]}}}} ``` ## The PublicApiDatasourceDiagnosticsWarehouseResponse\_ScanAndResultsConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceDiagnosticsWarehouseResponse_ScanAndResultsConfigurationDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiDatasourceResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceResponsibilitiesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasourceResponsibilityContentDTO"}},"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"]},"DatasourceResponsibilityContentDTO":{"type":"object","properties":{"managed":{"type":"boolean"},"role":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["managed","role","type"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The PublicApiDatasourceRoleRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceRoleRequestDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["name"]}}}} ``` ## The PublicApiDatasourceRolesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceRolesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"}},"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"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The PublicApiDatasourceTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]}}}} ``` ## The PublicApiDeleteAttributeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteAttributeResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteColumnMetricMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteColumnMetricMonitorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteCustomSqlMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteCustomSqlMonitorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteDataProductResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDataProductResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteDataStandardResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDataStandardResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteDatasetResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDatasetResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteDatasetRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDatasetRoleResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteDatasourceResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDatasourceResponse":{"type":"object","properties":{"message":{"type":"string"}}}}}} ``` ## The PublicApiDeleteDatasourceRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteDatasourceRoleResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteGlobalRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteGlobalRoleResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteMonitorResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteNotificationRuleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteNotificationRuleResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The PublicApiDeleteRunnerResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteRunnerResponse":{"type":"object"}}}} ``` ## The PublicApiDeleteSecretResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteSecretResponse":{"type":"object","properties":{"message":{"type":"string"}}}}}} ``` ## The PublicApiDeleteUserGroupResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDeleteUserGroupResponse":{"type":"object"}}}} ``` ## The PublicApiDisableUserResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDisableUserResponse":{"type":"object"}}}} ``` ## The PublicApiDiscoveredDatasetsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiDiscoveredDatasetsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DiscoveredDatasetContentDTO"}},"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"]},"DiscoveredDatasetContentDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"datasourceId":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"onboarded":{"type":"boolean"},"qualifiedName":{"type":"string"}},"required":["datasourceId","id","name","onboarded","qualifiedName"]}}}} ``` ## The PublicApiEnableUserResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiEnableUserResponse":{"type":"object"}}}} ``` ## The PublicApiEvaluateDataStandardScopeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiEvaluateDataStandardScopeResponse":{"type":"object","properties":{"dataStandardId":{"type":"string"},"datasetIds":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PublicApiExecuteDataStandardsRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiExecuteDataStandardsRequestDTO":{"type":"object","properties":{"datasetId":{"type":"string"}},"required":["datasetId"]}}}} ``` ## The PublicApiExecuteDataStandardsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiExecuteDataStandardsResponse":{"type":"object","properties":{"dataStandardIds":{"type":"array","items":{"type":"string"}},"scanId":{"type":"string"}}}}}} ``` ## The PublicApiGenerateContractRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGenerateContractRequestDTO":{"type":"object","properties":{"datasetIds":{"type":"array","items":{"type":"string"}},"datasetQualifiedNames":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PublicApiGenerateContractStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGenerateContractStatusResponse":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiGenerateContractStatusResponse_DatasetGenerationStatus"}},"operationId":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/GenerateContractOperationStateDTO"}}},"PublicApiGenerateContractStatusResponse_DatasetGenerationStatus":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"scanCloudUrl":{"type":"string"},"scanId":{"type":"string"},"scanState":{"type":"object","$ref":"#/components/schemas/ScanStateDTO"}}},"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]},"GenerateContractOperationStateDTO":{"type":"string","enum":["ongoing","completed","failed","canceled"]}}}} ``` ## The PublicApiGenerateContractStatusResponse\_DatasetGenerationStatus object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGenerateContractStatusResponse_DatasetGenerationStatus":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"scanCloudUrl":{"type":"string"},"scanId":{"type":"string"},"scanState":{"type":"object","$ref":"#/components/schemas/ScanStateDTO"}}},"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]}}}} ``` ## The PublicApiGetContractResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetContractResponse":{"type":"object","properties":{"contract":{"type":"object","$ref":"#/components/schemas/ContractContentDTO"}}},"ContractContentDTO":{"type":"object","properties":{"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiGetDataProductResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"}},"required":["dataProduct"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The `key` of the data product YAML. It is unique in the organization and cannot change. Use it as `dataProductName` in the paths."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The PublicApiGetDataStandardResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetDataStandardResponse":{"type":"object","properties":{"dataStandard":{"type":"object","$ref":"#/components/schemas/DataStandardContentDTO"}}},"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiGetDatasourceConfigurationFileContentsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetDatasourceConfigurationFileContentsResponse":{"type":"object","properties":{"configurationFileContents":{"type":"string"}}}}}} ``` ## The PublicApiGetDatasourceResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetDatasourceResponse":{"type":"object","properties":{"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDTO"}}},"PublicApiDatasourceDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceTypeDTO"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO","description":"The Soda model version of the datasource: `3` or `4`."}}},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]},"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The PublicApiGetEncryptionKeyResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetEncryptionKeyResponse":{"type":"object","properties":{"encryptionKey":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"}}},"MapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The PublicApiGetRunnerResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGetRunnerResponse":{"type":"object","properties":{"runner":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerDTO"}}},"PublicApiRunnerDTO":{"type":"object","properties":{"id":{"type":"string"},"isOnline":{"type":"boolean"},"label":{"type":"string"},"lastSeenTimestamp":{"type":"string","format":"date-time"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerTypeDTO"},"versions":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerVersionsDTO"}}},"PublicApiRunnerTypeDTO":{"type":"string","enum":["SELF_HOSTED","SODA_HOSTED"]},"PublicApiRunnerVersionsDTO":{"type":"object","properties":{"agent":{"type":"string","deprecated":true},"library":{"type":"string"},"runner":{"type":"string"}}}}}} ``` ## The PublicApiGlobalResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGlobalResponsibilitiesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GlobalResponsibilityContentDTO"}},"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"]},"GlobalResponsibilityContentDTO":{"type":"object","properties":{"managed":{"type":"boolean","description":"True when Soda maintains this assignment itself, for example one granted through an identity provider group. Updating the global responsibilities leaves managed assignments untouched."},"role":{"type":"object","$ref":"#/components/schemas/GlobalRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["managed","role","type"]},"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The PublicApiGlobalRoleRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGlobalRoleRequestDTO":{"type":"object","properties":{"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["name"]}}}} ``` ## The PublicApiGlobalRolesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiGlobalRolesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GlobalRoleContentDTO"}},"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"]},"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiImpactAssessmentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiImpactAssessmentDTO":{"type":"object","properties":{"affectedResources":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaAffectedResourceDTO"}},"blastRadius":{"type":"object","$ref":"#/components/schemas/PublicApiBlastRadiusDTO"},"summary":{"type":"string"}}},"PublicApiRcaAffectedResourceDTO":{"type":"object","properties":{"description":{"type":"string"},"metrics":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaMetricDTO"}},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"}},"required":["description","resource"]},"PublicApiRcaMetricDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]},"PublicApiBlastRadiusDTO":{"type":"object","properties":{"assetType":{"type":"object","$ref":"#/components/schemas/RcaAssetTypeDTO"},"count":{"type":"integer","format":"int32"}}},"RcaAssetTypeDTO":{"type":"string","enum":["dataset","datasource"]}}}} ``` ## The PublicApiIncidentCheckDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentCheckDTO":{"type":"object","properties":{"checkResults":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentCheckResultDTO"}},"columnName":{"type":"string"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentDatasetDTO"}},"id":{"type":"string"},"lastCheckResultLevel":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"name":{"type":"string"}},"required":["checkResults","datasets","id","name"]},"PublicApiIncidentCheckResultDTO":{"type":"object","properties":{"id":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced this result ran, not when it was linked to the incident."}},"required":["id"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]},"PublicApiIncidentDatasetDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentResourceDTO"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiIncidentResourceDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiIncidentCheckResultDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentCheckResultDTO":{"type":"object","properties":{"id":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced this result ran, not when it was linked to the incident."}},"required":["id"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]}}}} ``` ## The PublicApiIncidentDatasetDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentDatasetDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentResourceDTO"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiIncidentResourceDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiIncidentResourceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentResourceDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiIncidentWithRcaReportDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentWithRcaReportDTO":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentCheckDTO"}},"created":{"type":"string","format":"date-time"},"hasRcaReport":{"type":"boolean"},"hasRestrictedContent":{"type":"boolean","description":"True when `checks` carries only part of what the incident is linked to, because the rest is on datasets you can not view. How much is held back is not given: the size of the difference would itself describe those datasets."},"lastUpdated":{"type":"string","format":"date-time"},"lead":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"reporter":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"description":{"type":"string"},"resolutionNotes":{"type":"string"},"severity":{"type":"object","$ref":"#/components/schemas/IncidentSeverityDTO"},"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","description","id","name","number","severity","status"]},"PublicApiIncidentCheckDTO":{"type":"object","properties":{"checkResults":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentCheckResultDTO"}},"columnName":{"type":"string"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentDatasetDTO"}},"id":{"type":"string"},"lastCheckResultLevel":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"name":{"type":"string"}},"required":["checkResults","datasets","id","name"]},"PublicApiIncidentCheckResultDTO":{"type":"object","properties":{"id":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced this result ran, not when it was linked to the incident."}},"required":["id"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]},"PublicApiIncidentDatasetDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentResourceDTO"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiIncidentResourceDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The PublicApiIncidentsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiIncidentsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentWithRcaReportDTO"}},"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"]},"PublicApiIncidentWithRcaReportDTO":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentCheckDTO"}},"created":{"type":"string","format":"date-time"},"hasRcaReport":{"type":"boolean"},"hasRestrictedContent":{"type":"boolean","description":"True when `checks` carries only part of what the incident is linked to, because the rest is on datasets you can not view. How much is held back is not given: the size of the difference would itself describe those datasets."},"lastUpdated":{"type":"string","format":"date-time"},"lead":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"reporter":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"description":{"type":"string"},"resolutionNotes":{"type":"string"},"severity":{"type":"object","$ref":"#/components/schemas/IncidentSeverityDTO"},"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","description","id","name","number","severity","status"]},"PublicApiIncidentCheckDTO":{"type":"object","properties":{"checkResults":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentCheckResultDTO"}},"columnName":{"type":"string"},"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentDatasetDTO"}},"id":{"type":"string"},"lastCheckResultLevel":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"name":{"type":"string"}},"required":["checkResults","datasets","id","name"]},"PublicApiIncidentCheckResultDTO":{"type":"object","properties":{"id":{"type":"string"},"level":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced this result ran, not when it was linked to the incident."}},"required":["id"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]},"PublicApiIncidentDatasetDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiIncidentResourceDTO"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiIncidentResourceDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The PublicApiInviteUserRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiInviteUserRequestDTO":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}}},"required":["emails"]}}}} ``` ## The PublicApiInviteUserResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiInviteUserResponse":{"type":"object","properties":{"failedInvitations":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/FailedInvitationDTO"}},"validInvitations":{"type":"array","items":{"type":"string"}}}},"FailedInvitationDTO":{"type":"object","properties":{"email":{"type":"string"},"error":{"type":"string"}}}}}} ``` ## The PublicApiListAttributesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListAttributesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/AttributeContentDTO"}},"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"]},"AttributeContentDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"resourceType":{"type":"object","$ref":"#/components/schemas/AttributeResourceTypeDTO"},"type":{"type":"object","$ref":"#/components/schemas/AttributeTypeDTO"}},"required":["id","label","name","resourceType","type"]},"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]},"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The PublicApiListAuditLogsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListAuditLogsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/AuditLogDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"AuditLogDTO":{"type":"object","properties":{"auditSteps":{"type":"array","description":"Details recorded during the operation, in recorded order. Empty when no steps were logged.","items":{"type":"object","$ref":"#/components/schemas/AuditLogStepDTO"}},"comment":{"type":"string","description":"Audited operation, usually a request or command name."},"email":{"type":"string"},"eventTime":{"type":"string","format":"date-time","description":"Timestamp of the overall operation in UTC at whole-second precision, used for filtering and ordering."},"id":{"type":"string"},"ipAddress":{"type":"string"},"maskedApiKey":{"type":"string","description":"Masked API key. Keys longer than eight characters retain the first and last two characters; keys of eight characters or fewer are fully masked."}},"required":["auditSteps","eventTime","id"]},"AuditLogStepDTO":{"type":"object","properties":{"comment":{"type":"string","description":"Detail or outcome recorded at this step of the operation."},"eventTime":{"type":"string","format":"date-time","description":"Timestamp of this step in UTC, retaining its original sub-second precision."}}}}}} ``` ## The PublicApiListContractVersionsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListContractVersionsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ContractVersionDTO"}},"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"]},"ContractVersionDTO":{"type":"object","properties":{"checksum":{"type":"string"},"contents":{"type":"string"},"contractId":{"type":"string"},"created":{"type":"string","format":"date-time"},"creatorId":{"type":"string"},"id":{"type":"string"}}}}}} ``` ## The PublicApiListContractsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListContractsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ContractContentDTO"}},"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"]},"ContractContentDTO":{"type":"object","properties":{"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiListDataProductInputsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDataProductInputsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductInputContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductInputContentDTO":{"type":"object","properties":{"checkResults":{"type":"object","$ref":"#/components/schemas/DataProductCheckResultsContentDTO"},"datasetId":{"type":"string"},"dqn":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductInputHealthContentDTO"},"id":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductInputStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductInputTypeContentDTO"}},"required":["id","state","type"]},"DataProductCheckResultsContentDTO":{"type":"object","properties":{"criticalFailingCount":{"type":"integer","format":"int32","description":"A subset of failingCount: the failing checks whose `severity` check attribute is `critical`."},"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}},"required":["criticalFailingCount","failingCount","notEvaluatedCount","passingCount","warningCount"]},"DataProductInputHealthContentDTO":{"type":"object","properties":{"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["state"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductInputStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductInputTypeContentDTO":{"type":"string","enum":["dataset"]}}}} ``` ## The PublicApiListDataProductsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDataProductsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The `key` of the data product YAML. It is unique in the organization and cannot change. Use it as `dataProductName` in the paths."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The PublicApiListDataStandardChecksResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDataStandardChecksResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardCheckContentDTO"}},"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"]},"DataStandardCheckContentDTO":{"type":"object","properties":{"checkType":{"type":"object","$ref":"#/components/schemas/CheckTypeDTO"},"compliance":{"type":"number"},"datasetCount":{"type":"integer","format":"int32"},"failingCount":{"type":"integer","format":"int32"},"lastScanTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"},"worstLevel":{"type":"object","$ref":"#/components/schemas/CheckResultLevelDTO"}}},"CheckTypeDTO":{"type":"string","enum":["missing","invalid","row_count","aggregate","schema","duplicate","freshness","failed_rows","metric","group_by","row_count_diff","aggregate_diff","freshness_diff","metric_diff","rows_diff","duplicate_diff","llm","hierarchy","fuzzy_duplicate","reference_diff","schema_diff"]},"CheckResultLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated","excluded"]}}}} ``` ## The PublicApiListDataStandardDatasetsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDataStandardDatasetsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardDatasetContentDTO"}},"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"]},"DataStandardDatasetContentDTO":{"type":"object","properties":{"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string","description":"Link to the dataset's page in Soda Cloud. That page covers the whole dataset, not only the checks of this data standard."},"id":{"type":"string"},"label":{"type":"string"},"lastScanId":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"qualifiedName":{"type":"string"}},"required":["id","name"]},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The PublicApiListDataStandardsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDataStandardsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardContentDTO"}},"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"]},"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiListDatasetColumnsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDatasetColumnsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetColumnContentDTO"}},"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"]},"PublicApiDatasetColumnContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"columnId":{"type":"string"},"columnName":{"type":"string"}},"required":["attributes","columnId","columnName"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The PublicApiListDatasetsMetricMonitoringRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDatasetsMetricMonitoringRequestDTO":{"type":"object","properties":{"datasetIds":{"type":"array","description":"Ids of the datasets to read. Additive with `datasetQualifiedNames`.","items":{"type":"string"}},"datasetQualifiedNames":{"type":"array","description":"Qualified names of the datasets to read, for example `my_datasource/my_schema/my_table`. Additive with `datasetIds`.","items":{"type":"string"}}}}}}} ``` ## The PublicApiListDatasetsMetricMonitoringResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDatasetsMetricMonitoringResponse":{"type":"object","properties":{"datasets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiListDatasetsMetricMonitoringResponse_DatasetMetricMonitoringConfigurationDTO"}}}},"PublicApiListDatasetsMetricMonitoringResponse_DatasetMetricMonitoringConfigurationDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetMetricMonitorsConfiguration":{"type":"array","description":"Configuration of the dataset-level monitors only. Use `GET /api/v1/datasets/{datasetId}/metricMonitoring` for the column and custom SQL monitors.","items":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO"}},"datasetQualifiedName":{"type":"string"},"enabled":{"type":"boolean"},"historicalMetricCollectionScanStartDate":{"type":"string","format":"date-time"},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}}},"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","recordAnomalyScore"]},"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"]}}}} ``` ## The PublicApiListDatasetsMetricMonitoringResponse\_DatasetMetricMonitoringConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDatasetsMetricMonitoringResponse_DatasetMetricMonitoringConfigurationDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetMetricMonitorsConfiguration":{"type":"array","description":"Configuration of the dataset-level monitors only. Use `GET /api/v1/datasets/{datasetId}/metricMonitoring` for the column and custom SQL monitors.","items":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO"}},"datasetQualifiedName":{"type":"string"},"enabled":{"type":"boolean"},"historicalMetricCollectionScanStartDate":{"type":"string","format":"date-time"},"scanSchedule":{"type":"object","$ref":"#/components/schemas/ZonedCronDTO"},"timePartition":{"type":"object","$ref":"#/components/schemas/DatasetTimePartitionDTO"}}},"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","recordAnomalyScore"]},"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"]}}}} ``` ## The PublicApiListDatasourcesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListDatasourcesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDTO"}},"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"]},"PublicApiDatasourceDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceTypeDTO"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO","description":"The Soda model version of the datasource: `3` or `4`."}}},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]},"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The PublicApiListMonitorsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListMonitorsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/MonitorContentDTO"}},"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"]},"MonitorContentDTO":{"type":"object","properties":{"anomalousGroupMembersCount":{"type":"integer","format":"int32","description":"How many group members have a latest result that failed. Null outside the group parent monitor."},"columnName":{"type":"string","description":"Column the monitor watches. Null for a monitor that watches the whole dataset, and for a custom SQL monitor that has no column."},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO","description":"Outcome of the monitor's most recent result. `notEvaluated` while it has never run."},"groupByColumnValues":{"type":"array","description":"The group-by values of this group member, such as `country = BE`. Null on the group parent monitor.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnValueDTO"}},"groupByColumns":{"type":"array","description":"The columns a group-by monitor groups on. Null outside the group parent monitor.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"groupIdentity":{"type":"string","description":"Shared by the group parent monitor and its group members. Null outside group-by monitors."},"groupMembersCount":{"type":"integer","format":"int32","description":"How many group members the group-by monitor has. Null outside the group parent monitor."},"hasNotificationRules":{"type":"boolean"},"isEnabled":{"type":"boolean"},"lastDataTimestamp":{"type":"string","format":"date-time","description":"Data timestamp of the monitor's most recent result. Null while it has never run."},"metricType":{"type":"object","$ref":"#/components/schemas/MonitorMetricTypeDTO"},"monitorId":{"type":"string","description":"The id of the monitor, which the other `/api/v1/monitors` endpoints take."},"monitorName":{"type":"string"},"monitorType":{"type":"object","$ref":"#/components/schemas/MonitorTypeDTO"}},"required":["evaluationStatus","metricType","monitorId","monitorType"]},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"GroupByColumnValueDTO":{"type":"object","properties":{"columnName":{"type":"string"},"columnValue":{"type":"object","$ref":"#/components/schemas/_object","description":"The value as the data holds it: a string, a number or a boolean."}},"required":["columnName"]},"_object":{"type":"object"},"GroupByColumnConfigurationDTO":{"type":"object","properties":{"columnName":{"type":"string"},"excludedValues":{"type":"array","items":{"type":"string"}}},"required":["columnName"]},"MonitorMetricTypeDTO":{"type":"string","enum":["schema","rowCount","rowsInserted","totalRowCountChange","timeliness","freshness","recordAnomalyScore","average","missingPercentage","columnFreshness","sum","distinctValuesCount","count","minimumValue","maximumValue","duplicateValuesPercentage","minimumLength","maximumLength","averageLength","standardDeviation","variance","q1","median","q3","customSql"]},"MonitorTypeDTO":{"type":"string","enum":["dataset","column","customSql"]}}}} ``` ## The PublicApiListNotificationIntegrationsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListNotificationIntegrationsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiNotificationIntegrationDTO"}},"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"]},"PublicApiNotificationIntegrationDTO":{"type":"object","properties":{"channels":{"type":"array","description":"Configured Slack channels usable as notification-rule integrationChannel values. Empty for other providers or when no channels are configured; channels are not refreshed by this endpoint.","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"notificationsEnabled":{"type":"boolean","description":"Whether the notification capability is enabled, independently of the integration status."},"status":{"type":"object","$ref":"#/components/schemas/NotificationIntegrationStatusDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationIntegrationTypeDTO"}},"required":["channels","id","notificationsEnabled","status","type"]},"NotificationIntegrationStatusDTO":{"type":"string","enum":["enabled","disabled"]},"NotificationIntegrationTypeDTO":{"type":"string","enum":["slack","microsoftTeams","webhook"]}}}} ``` ## The PublicApiListNotificationRulesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListNotificationRulesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiNotificationRuleDTO"}},"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"]},"PublicApiNotificationRuleDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"customization":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationDTO"},"filter":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"id":{"type":"string"},"isDefault":{"type":"boolean"},"lastTriggeredAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"ownerId":{"type":"string"},"recipients":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientDTO"}},"ruleType":{"type":"object","$ref":"#/components/schemas/PublicApiRuleTypeDTO"},"status":{"type":"object","$ref":"#/components/schemas/NotificationRuleStatusDTO"},"updatedAt":{"type":"string","format":"date-time"}}},"NotificationCustomizationDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationTypeDTO"}},"required":["type"]},"NotificationCustomizationTypeDTO":{"type":"string","enum":["rich","minimal","matchedChecks"]},"NotificationFilterDTO":{"type":"object","properties":{"caseInsensitive":{"type":"boolean"},"expression":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"expressions":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"}},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationFilterTypeDTO"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["type"]},"NotificationFilterFieldDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldTypeDTO"}},"required":["field"]},"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]},"NotificationFilterTypeDTO":{"type":"string","enum":["equals","contains","in","and","or","not"]},"NotificationRecipientDTO":{"type":"object","properties":{"customRoleId":{"type":"string"},"email":{"type":"string"},"integrationChannel":{"type":"string"},"integrationId":{"type":"string"},"role":{"type":"object","$ref":"#/components/schemas/NotificationRecipientRoleDTO"},"triggers":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTriggerDTO"}},"type":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["triggers","type"]},"NotificationRecipientRoleDTO":{"type":"string","enum":["datasetOwner","monitorOwner"]},"NotificationRecipientTriggerDTO":{"type":"object","properties":{"level":{"type":"object","$ref":"#/components/schemas/NotificationLevelDTO"},"scanState":{"type":"object","$ref":"#/components/schemas/NotificationScanStateDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationTriggerTypeDTO"}},"required":["type"]},"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]},"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]},"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]},"NotificationRecipientTypeDTO":{"type":"string","enum":["email","user","userGroup","integration","resourceRole","customRole"]},"PublicApiRuleTypeDTO":{"type":"string","enum":["check","monitor"]},"NotificationRuleStatusDTO":{"type":"string","enum":["active","paused"]}}}} ``` ## The PublicApiListRunnersResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListRunnersResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerDTO"}},"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"]},"PublicApiRunnerDTO":{"type":"object","properties":{"id":{"type":"string"},"isOnline":{"type":"boolean"},"label":{"type":"string"},"lastSeenTimestamp":{"type":"string","format":"date-time"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerTypeDTO"},"versions":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerVersionsDTO"}}},"PublicApiRunnerTypeDTO":{"type":"string","enum":["SELF_HOSTED","SODA_HOSTED"]},"PublicApiRunnerVersionsDTO":{"type":"object","properties":{"agent":{"type":"string","deprecated":true},"library":{"type":"string"},"runner":{"type":"string"}}}}}} ``` ## The PublicApiListSecretsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiListSecretsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiSecretDTO"}},"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"]},"PublicApiSecretDTO":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}} ``` ## The PublicApiMetricMonitoringUpdateOperationStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiMetricMonitoringUpdateOperationStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiMonitorResponse":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO","description":"Set when the monitor is a column metric monitor."},"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO","description":"Set when the monitor is a custom SQL monitor."},"datasetId":{"type":"string"},"datasetMetricMonitor":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO","description":"Set when the monitor is a dataset metric monitor."},"monitorId":{"type":"string","description":"The id of the monitor. Column and custom SQL monitor objects repeat it as `checkId`."}},"required":["datasetId","monitorId"]},"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","recordAnomalyScore"]}}}} ``` ## The PublicApiMonitorResultsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiMonitorResultsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/MonitorResultContentDTO"}},"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"]},"MonitorResultContentDTO":{"type":"object","properties":{"dataTimestamp":{"type":"string","format":"date-time","description":"The moment in the data the result is about, which `from` and `to` filter on."},"diagnostics":{"type":"object","$ref":"#/components/schemas/MonitorResultDiagnosticsDTO","description":"What one type of monitor adds to its result, with one key per type. Only the key of this monitor's type is set. Null when the monitor's type adds nothing."},"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"expectedRange":{"type":"object","$ref":"#/components/schemas/MonitorExpectedRangeDTO","description":"The range the value had to fall in to pass, bounds included. A null bound means the value could not fail on that side. Null when the monitor did not evaluate the value, or could not fail on either side."},"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO"},"id":{"type":"string"},"incident":{"type":"object","$ref":"#/components/schemas/IncidentSlimDTO"},"monitorId":{"type":"string"},"predictedValue":{"type":"number"},"scanId":{"type":"string"},"scanTime":{"type":"string","format":"date-time","description":"When the scan that produced the result ran."},"value":{"type":"number","description":"The measured metric. For record anomaly detection, the anomaly score from 0 to 1."}},"required":["dataTimestamp","evaluationStatus","id","monitorId"]},"MonitorResultDiagnosticsDTO":{"type":"object","properties":{"recordAnomalyDetection":{"type":"object","$ref":"#/components/schemas/RecordAnomalyDetectionDiagnosticsDTO"}}},"RecordAnomalyDetectionDiagnosticsDTO":{"type":"object","properties":{"explanation":{"type":"object","$ref":"#/components/schemas/RadExplanationDTO","description":"Why the partition looked unusual. Null when the run produced no explanation."},"monitoredColumns":{"type":"array","description":"The columns this run compared. Empty when it compared none, as on a run without a score.","items":{"type":"string"}},"partition":{"type":"object","$ref":"#/components/schemas/RadPartitionDTO"},"reference":{"type":"object","$ref":"#/components/schemas/RadReferencePartitionDTO","description":"The past partition that looked most like this one. The explanation compares against it. Null when no past partition was selected, as on a `skipped` run."},"runPhase":{"type":"object","$ref":"#/components/schemas/RadRunPhaseDTO","description":"`skipped`: the run produced no score, for example because the partition was empty, had too few rows, or had too few past partitions to compare with. `warmingUp`: fewer past partitions are available than the full window, so a score is less settled. `steady`: the full window of past partitions is available."}},"required":["monitoredColumns","partition","runPhase"]},"RadExplanationDTO":{"type":"object","properties":{"columnEffects":{"type":"array","description":"Columns whose values shifted across the whole partition. Empty when no column stood out.","items":{"type":"object","$ref":"#/components/schemas/RadColumnEffectDTO"}},"segmentEffects":{"type":"array","description":"Columns whose values shifted more within a slice of rows than across the whole partition. Empty when no slice stood out.","items":{"type":"object","$ref":"#/components/schemas/RadSegmentEffectDTO"}}},"required":["columnEffects","segmentEffects"]},"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]},"RadPartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"rowCount":{"type":"integer","format":"int32","description":"Rows in the whole partition, not in the sample the bucket counts are taken from. 0 means the partition was empty."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadReferencePartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadRunPhaseDTO":{"type":"string","enum":["skipped","warmingUp","steady"]},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"MonitorExpectedRangeDTO":{"type":"object","properties":{"lower":{"type":"number"},"upper":{"type":"number"}}},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}},"IncidentSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"number":{"type":"integer","format":"int32"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"}},"required":["cloudUrl","id","name","number","status"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The PublicApiNotificationIntegrationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiNotificationIntegrationDTO":{"type":"object","properties":{"channels":{"type":"array","description":"Configured Slack channels usable as notification-rule integrationChannel values. Empty for other providers or when no channels are configured; channels are not refreshed by this endpoint.","items":{"type":"string"}},"id":{"type":"string"},"name":{"type":"string"},"notificationsEnabled":{"type":"boolean","description":"Whether the notification capability is enabled, independently of the integration status."},"status":{"type":"object","$ref":"#/components/schemas/NotificationIntegrationStatusDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationIntegrationTypeDTO"}},"required":["channels","id","notificationsEnabled","status","type"]},"NotificationIntegrationStatusDTO":{"type":"string","enum":["enabled","disabled"]},"NotificationIntegrationTypeDTO":{"type":"string","enum":["slack","microsoftTeams","webhook"]}}}} ``` ## The PublicApiNotificationRuleDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiNotificationRuleDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"customization":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationDTO"},"filter":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"id":{"type":"string"},"isDefault":{"type":"boolean"},"lastTriggeredAt":{"type":"string","format":"date-time"},"name":{"type":"string"},"ownerId":{"type":"string"},"recipients":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientDTO"}},"ruleType":{"type":"object","$ref":"#/components/schemas/PublicApiRuleTypeDTO"},"status":{"type":"object","$ref":"#/components/schemas/NotificationRuleStatusDTO"},"updatedAt":{"type":"string","format":"date-time"}}},"NotificationCustomizationDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationTypeDTO"}},"required":["type"]},"NotificationCustomizationTypeDTO":{"type":"string","enum":["rich","minimal","matchedChecks"]},"NotificationFilterDTO":{"type":"object","properties":{"caseInsensitive":{"type":"boolean"},"expression":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"expressions":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"}},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationFilterTypeDTO"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["type"]},"NotificationFilterFieldDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldTypeDTO"}},"required":["field"]},"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]},"NotificationFilterTypeDTO":{"type":"string","enum":["equals","contains","in","and","or","not"]},"NotificationRecipientDTO":{"type":"object","properties":{"customRoleId":{"type":"string"},"email":{"type":"string"},"integrationChannel":{"type":"string"},"integrationId":{"type":"string"},"role":{"type":"object","$ref":"#/components/schemas/NotificationRecipientRoleDTO"},"triggers":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTriggerDTO"}},"type":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["triggers","type"]},"NotificationRecipientRoleDTO":{"type":"string","enum":["datasetOwner","monitorOwner"]},"NotificationRecipientTriggerDTO":{"type":"object","properties":{"level":{"type":"object","$ref":"#/components/schemas/NotificationLevelDTO"},"scanState":{"type":"object","$ref":"#/components/schemas/NotificationScanStateDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationTriggerTypeDTO"}},"required":["type"]},"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]},"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]},"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]},"NotificationRecipientTypeDTO":{"type":"string","enum":["email","user","userGroup","integration","resourceRole","customRole"]},"PublicApiRuleTypeDTO":{"type":"string","enum":["check","monitor"]},"NotificationRuleStatusDTO":{"type":"string","enum":["active","paused"]}}}} ``` ## The PublicApiNotificationRuleRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiNotificationRuleRequestDTO":{"type":"object","properties":{"customization":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationDTO"},"filter":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"name":{"type":"string"},"recipients":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientDTO"}},"ruleType":{"type":"object","$ref":"#/components/schemas/PublicApiRuleTypeDTO"},"status":{"type":"object","$ref":"#/components/schemas/NotificationRuleStatusDTO"}},"required":["name","recipients","ruleType"]},"NotificationCustomizationDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/NotificationCustomizationTypeDTO"}},"required":["type"]},"NotificationCustomizationTypeDTO":{"type":"string","enum":["rich","minimal","matchedChecks"]},"NotificationFilterDTO":{"type":"object","properties":{"caseInsensitive":{"type":"boolean"},"expression":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"},"expressions":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationFilterDTO"}},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationFilterTypeDTO"},"value":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"required":["type"]},"NotificationFilterFieldDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"field":{"type":"object","$ref":"#/components/schemas/NotificationFilterFieldTypeDTO"}},"required":["field"]},"NotificationFilterFieldTypeDTO":{"type":"string","enum":["datasourceId","datasourceLabel","datasetId","datasetLabel","datasetOwnerId","datasetTags","checkId","checkName","checkOwnerId","columnId","metricType","contractScopeKey","datasetResourceAttribute","checkResourceAttribute"]},"NotificationFilterTypeDTO":{"type":"string","enum":["equals","contains","in","and","or","not"]},"NotificationRecipientDTO":{"type":"object","properties":{"customRoleId":{"type":"string"},"email":{"type":"string"},"integrationChannel":{"type":"string"},"integrationId":{"type":"string"},"role":{"type":"object","$ref":"#/components/schemas/NotificationRecipientRoleDTO"},"triggers":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTriggerDTO"}},"type":{"type":"object","$ref":"#/components/schemas/NotificationRecipientTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["triggers","type"]},"NotificationRecipientRoleDTO":{"type":"string","enum":["datasetOwner","monitorOwner"]},"NotificationRecipientTriggerDTO":{"type":"object","properties":{"level":{"type":"object","$ref":"#/components/schemas/NotificationLevelDTO"},"scanState":{"type":"object","$ref":"#/components/schemas/NotificationScanStateDTO"},"type":{"type":"object","$ref":"#/components/schemas/NotificationTriggerTypeDTO"}},"required":["type"]},"NotificationLevelDTO":{"type":"string","enum":["info","warning","critical","not_evaluated"]},"NotificationScanStateDTO":{"type":"string","enum":["failed","timedOut","canceled","completedWithErrors"]},"NotificationTriggerTypeDTO":{"type":"string","enum":["testResultLevel","scanState"]},"NotificationRecipientTypeDTO":{"type":"string","enum":["email","user","userGroup","integration","resourceRole","customRole"]},"PublicApiRuleTypeDTO":{"type":"string","enum":["check","monitor"]},"NotificationRuleStatusDTO":{"type":"string","enum":["active","paused"]}}}} ``` ## The PublicApiOnboardDatasetsRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiOnboardDatasetsRequestDTO":{"type":"object","properties":{"discoveredDatasetIds":{"type":"array","items":{"type":"string"}}},"required":["discoveredDatasetIds"]}}}} ``` ## The PublicApiOnboardDatasetsStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiOnboardDatasetsStatusResponse":{"type":"object","properties":{"ended":{"type":"string","format":"date-time"},"id":{"type":"string"},"message":{"type":"string"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/PublicApiOnboardingStateDTO"}},"required":["id","state"]},"PublicApiOnboardingStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiOnboardingStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiOnboardingStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiOrganisationLicensingResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiOrganisationLicensingResponse":{"type":"object","properties":{"plan":{"type":"object","$ref":"#/components/schemas/PublicApiPlanDTO"},"planFeatures":{"type":"object","$ref":"#/components/schemas/PublicApiPlanFeaturesDTO","description":"The limits the plan grants."},"subscription":{"type":"object","$ref":"#/components/schemas/PublicApiSubscriptionDTO"},"trialExpirationTime":{"type":"string","format":"date-time","description":"Only set while the organization is on the trial plan."}}},"PublicApiPlanDTO":{"type":"string","enum":["trial","free","starter","premier","enterprise","teams","enterpriseUserBased","datasetStandard","spus"]},"PublicApiPlanFeaturesDTO":{"type":"object","properties":{"activeChecks":{"type":"integer","format":"int32"},"authorUsers":{"type":"integer","format":"int32"},"concurrentScans":{"type":"integer","format":"int32"},"datasetCount":{"type":"integer","format":"int32"},"prepaidSPUs":{"type":"integer","format":"int64"},"users":{"type":"integer","format":"int32"}},"required":["concurrentScans"]},"PublicApiSubscriptionDTO":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiPlanDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPlanDTO":{"type":"string","enum":["trial","free","starter","premier","enterprise","teams","enterpriseUserBased","datasetStandard","spus"]}}}} ``` ## The PublicApiPlanFeaturesDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPlanFeaturesDTO":{"type":"object","properties":{"activeChecks":{"type":"integer","format":"int32"},"authorUsers":{"type":"integer","format":"int32"},"concurrentScans":{"type":"integer","format":"int32"},"datasetCount":{"type":"integer","format":"int32"},"prepaidSPUs":{"type":"integer","format":"int64"},"users":{"type":"integer","format":"int32"}},"required":["concurrentScans"]}}}} ``` ## The PublicApiPostProcessingStageDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPostProcessingStageDTO":{"type":"object","properties":{"ended":{"type":"string","format":"date-time"},"name":{"type":"object","$ref":"#/components/schemas/PublicApiPostProcessingStageTypeDTO"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/PublicApiPostProcessingStageStateDTO"}},"required":["name"]},"PublicApiPostProcessingStageTypeDTO":{"type":"string","enum":["diagnosticWarehouse"]},"PublicApiPostProcessingStageStateDTO":{"type":"string","enum":["ongoing","completed","failed"]}}}} ``` ## The PublicApiPostProcessingStageStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPostProcessingStageStateDTO":{"type":"string","enum":["ongoing","completed","failed"]}}}} ``` ## The PublicApiPostProcessingStageTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPostProcessingStageTypeDTO":{"type":"string","enum":["diagnosticWarehouse"]}}}} ``` ## The PublicApiPreviewDataStandardScopeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPreviewDataStandardScopeRequestDTO":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"size":{"type":"integer","format":"int32"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]}}}} ``` ## The PublicApiPreviewDataStandardScopeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPreviewDataStandardScopeResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeMatchingDatasetContentDTO"}},"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"]},"DataStandardScopeMatchingDatasetContentDTO":{"type":"object","properties":{"datasourceId":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}},"required":["datasourceId","id","name"]}}}} ``` ## The PublicApiPublishContractRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPublishContractRequestDTO":{"type":"object","properties":{"contents":{"type":"string"}},"required":["contents"]}}}} ``` ## The PublicApiPublishContractResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiPublishContractResponse":{"type":"object","properties":{"contract":{"type":"object","$ref":"#/components/schemas/ContractContentDTO"}}},"ContractContentDTO":{"type":"object","properties":{"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiRcaAffectedResourceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaAffectedResourceDTO":{"type":"object","properties":{"description":{"type":"string"},"metrics":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaMetricDTO"}},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"}},"required":["description","resource"]},"PublicApiRcaMetricDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]}}}} ``` ## The PublicApiRcaAgentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaAgentDTO":{"type":"object","properties":{"model":{"type":"string"},"name":{"type":"string"},"sessionId":{"type":"string"},"version":{"type":"string"}},"required":["name"]}}}} ``` ## The PublicApiRcaEvidenceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaEvidenceDTO":{"type":"object","properties":{"kind":{"type":"string"},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"text":{"type":"string"}}},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]}}}} ``` ## The PublicApiRcaInvestigationStepDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaInvestigationStepDTO":{"type":"object","properties":{"detail":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaEvidenceDTO"}},"order":{"type":"integer","format":"int32"},"title":{"type":"string"}},"required":["title"]},"PublicApiRcaEvidenceDTO":{"type":"object","properties":{"kind":{"type":"string"},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"text":{"type":"string"}}},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]}}}} ``` ## The PublicApiRcaLineageDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaLineageDTO":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageEdgeDTO"}},"nodes":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageNodeDTO"}}}},"PublicApiRcaLineageEdgeDTO":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"PublicApiRcaLineageNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"incidentAsset":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"platform":{"type":"string"},"sodaResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaNodeStatusDTO"}},"required":["id","name"]},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]},"RcaNodeStatusDTO":{"type":"string","enum":["rootCause","affected","healthy"]}}}} ``` ## The PublicApiRcaLineageEdgeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaLineageEdgeDTO":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]}}}} ``` ## The PublicApiRcaLineageNodeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaLineageNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"incidentAsset":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"platform":{"type":"string"},"sodaResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaNodeStatusDTO"}},"required":["id","name"]},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]},"RcaNodeStatusDTO":{"type":"string","enum":["rootCause","affected","healthy"]}}}} ``` ## The PublicApiRcaMetricDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaMetricDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}}}} ``` ## The PublicApiRcaRemediationItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaRemediationItemDTO":{"type":"object","properties":{"action":{"type":"string"},"priority":{"type":"object","$ref":"#/components/schemas/RcaPriorityDTO"}},"required":["action"]},"RcaPriorityDTO":{"type":"string","enum":["low","medium","high","urgent"]}}}} ``` ## The PublicApiRcaReportContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaReportContentDTO":{"type":"object","properties":{"agentName":{"type":"string"},"blastRadiusAssetType":{"type":"object","$ref":"#/components/schemas/RcaAssetTypeDTO"},"blastRadiusCount":{"type":"integer","format":"int32"},"confidence":{"type":"object","$ref":"#/components/schemas/RcaConfidenceDTO"},"durationSeconds":{"type":"integer","format":"int32"},"generatedAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"impactSummary":{"type":"string"},"incidentId":{"type":"string"},"publishedAt":{"type":"string","format":"date-time"},"rootCauseSummary":{"type":"string"},"status":{"type":"object","$ref":"#/components/schemas/RcaReportStatusDTO"}}},"RcaAssetTypeDTO":{"type":"string","enum":["dataset","datasource"]},"RcaConfidenceDTO":{"type":"string","enum":["high","medium","low"]},"RcaReportStatusDTO":{"type":"string","enum":["completed","partial","inconclusive","failed"]}}}} ``` ## The PublicApiRcaReportDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaReportDTO":{"type":"object","properties":{"agent":{"type":"object","$ref":"#/components/schemas/PublicApiRcaAgentDTO"},"impactAssessment":{"type":"object","$ref":"#/components/schemas/PublicApiImpactAssessmentDTO"},"rootCauseAnalysis":{"type":"object","$ref":"#/components/schemas/PublicApiRootCauseAnalysisDTO"}},"required":["agent","rootCauseAnalysis"]},"PublicApiRcaAgentDTO":{"type":"object","properties":{"model":{"type":"string"},"name":{"type":"string"},"sessionId":{"type":"string"},"version":{"type":"string"}},"required":["name"]},"PublicApiImpactAssessmentDTO":{"type":"object","properties":{"affectedResources":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaAffectedResourceDTO"}},"blastRadius":{"type":"object","$ref":"#/components/schemas/PublicApiBlastRadiusDTO"},"summary":{"type":"string"}}},"PublicApiRcaAffectedResourceDTO":{"type":"object","properties":{"description":{"type":"string"},"metrics":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaMetricDTO"}},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"}},"required":["description","resource"]},"PublicApiRcaMetricDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]},"PublicApiBlastRadiusDTO":{"type":"object","properties":{"assetType":{"type":"object","$ref":"#/components/schemas/RcaAssetTypeDTO"},"count":{"type":"integer","format":"int32"}}},"RcaAssetTypeDTO":{"type":"string","enum":["dataset","datasource"]},"PublicApiRootCauseAnalysisDTO":{"type":"object","properties":{"confidence":{"type":"object","$ref":"#/components/schemas/RcaConfidenceDTO"},"durationSeconds":{"type":"integer","format":"int32"},"generatedAt":{"type":"string","format":"date-time"},"investigation":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaInvestigationStepDTO"}},"lineage":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageDTO"},"remediation":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaRemediationItemDTO"}},"rootCauseResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaReportStatusDTO"},"summary":{"type":"string"}},"required":["confidence","generatedAt","status","summary"]},"RcaConfidenceDTO":{"type":"string","enum":["high","medium","low"]},"PublicApiRcaInvestigationStepDTO":{"type":"object","properties":{"detail":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaEvidenceDTO"}},"order":{"type":"integer","format":"int32"},"title":{"type":"string"}},"required":["title"]},"PublicApiRcaEvidenceDTO":{"type":"object","properties":{"kind":{"type":"string"},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"text":{"type":"string"}}},"PublicApiRcaLineageDTO":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageEdgeDTO"}},"nodes":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageNodeDTO"}}}},"PublicApiRcaLineageEdgeDTO":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"PublicApiRcaLineageNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"incidentAsset":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"platform":{"type":"string"},"sodaResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaNodeStatusDTO"}},"required":["id","name"]},"RcaNodeStatusDTO":{"type":"string","enum":["rootCause","affected","healthy"]},"PublicApiRcaRemediationItemDTO":{"type":"object","properties":{"action":{"type":"string"},"priority":{"type":"object","$ref":"#/components/schemas/RcaPriorityDTO"}},"required":["action"]},"RcaPriorityDTO":{"type":"string","enum":["low","medium","high","urgent"]},"RcaReportStatusDTO":{"type":"string","enum":["completed","partial","inconclusive","failed"]}}}} ``` ## The PublicApiRcaResourceRefDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]}}}} ``` ## The PublicApiRootCauseAnalysisDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRootCauseAnalysisDTO":{"type":"object","properties":{"confidence":{"type":"object","$ref":"#/components/schemas/RcaConfidenceDTO"},"durationSeconds":{"type":"integer","format":"int32"},"generatedAt":{"type":"string","format":"date-time"},"investigation":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaInvestigationStepDTO"}},"lineage":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageDTO"},"remediation":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaRemediationItemDTO"}},"rootCauseResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaReportStatusDTO"},"summary":{"type":"string"}},"required":["confidence","generatedAt","status","summary"]},"RcaConfidenceDTO":{"type":"string","enum":["high","medium","low"]},"PublicApiRcaInvestigationStepDTO":{"type":"object","properties":{"detail":{"type":"string"},"evidence":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaEvidenceDTO"}},"order":{"type":"integer","format":"int32"},"title":{"type":"string"}},"required":["title"]},"PublicApiRcaEvidenceDTO":{"type":"object","properties":{"kind":{"type":"string"},"resource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"text":{"type":"string"}}},"PublicApiRcaResourceRefDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/RcaResourceTypeDTO"},"url":{"type":"string"}},"required":["id","type"]},"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]},"PublicApiRcaLineageDTO":{"type":"object","properties":{"edges":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageEdgeDTO"}},"nodes":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiRcaLineageNodeDTO"}}}},"PublicApiRcaLineageEdgeDTO":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}},"required":["from","to"]},"PublicApiRcaLineageNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"incidentAsset":{"type":"boolean"},"name":{"type":"string"},"namespace":{"type":"string"},"platform":{"type":"string"},"sodaResource":{"type":"object","$ref":"#/components/schemas/PublicApiRcaResourceRefDTO"},"status":{"type":"object","$ref":"#/components/schemas/RcaNodeStatusDTO"}},"required":["id","name"]},"RcaNodeStatusDTO":{"type":"string","enum":["rootCause","affected","healthy"]},"PublicApiRcaRemediationItemDTO":{"type":"object","properties":{"action":{"type":"string"},"priority":{"type":"object","$ref":"#/components/schemas/RcaPriorityDTO"}},"required":["action"]},"RcaPriorityDTO":{"type":"string","enum":["low","medium","high","urgent"]},"RcaReportStatusDTO":{"type":"string","enum":["completed","partial","inconclusive","failed"]}}}} ``` ## The PublicApiRuleTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRuleTypeDTO":{"type":"string","enum":["check","monitor"]}}}} ``` ## The PublicApiRunnerDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRunnerDTO":{"type":"object","properties":{"id":{"type":"string"},"isOnline":{"type":"boolean"},"label":{"type":"string"},"lastSeenTimestamp":{"type":"string","format":"date-time"},"name":{"type":"string"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerTypeDTO"},"versions":{"type":"object","$ref":"#/components/schemas/PublicApiRunnerVersionsDTO"}}},"PublicApiRunnerTypeDTO":{"type":"string","enum":["SELF_HOSTED","SODA_HOSTED"]},"PublicApiRunnerVersionsDTO":{"type":"object","properties":{"agent":{"type":"string","deprecated":true},"library":{"type":"string"},"runner":{"type":"string"}}}}}} ``` ## The PublicApiRunnerTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRunnerTypeDTO":{"type":"string","enum":["SELF_HOSTED","SODA_HOSTED"]}}}} ``` ## The PublicApiRunnerVersionsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiRunnerVersionsDTO":{"type":"object","properties":{"agent":{"type":"string","deprecated":true},"library":{"type":"string"},"runner":{"type":"string"}}}}}} ``` ## The PublicApiScanDefinitionSlim object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiScanDefinitionSlim":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiScanLogsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiScanLogsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/LogsContentDTO"}},"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"]},"LogsContentDTO":{"type":"object","properties":{"index":{"type":"integer","format":"int32"},"level":{"type":"object","$ref":"#/components/schemas/LogLevelDTO"},"message":{"type":"string"},"timestamp":{"type":"string","format":"date-time"}},"required":["index","level","message","timestamp"]},"LogLevelDTO":{"type":"string","enum":["debug","info","warning","error"]}}}} ``` ## The PublicApiScanStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiScanStatusResponse":{"type":"object","properties":{"agentId":{"type":"string","deprecated":true},"checks":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiCheckSlimDTO"}},"cloudUrl":{"type":"string"},"contractDatasetCloudUrl":{"type":"string"},"created":{"type":"string","format":"date-time"},"ended":{"type":"string","format":"date-time"},"errors":{"type":"integer","format":"int32","description":"Number of scan-level errors. Does not count ERROR-level log entries and may be zero even when the state reports errors or failure."},"failureReason":{"type":"string","description":"Failure diagnostic for scans in the failed state, including when no scan logs are available."},"failures":{"type":"integer","format":"int32"},"id":{"type":"string"},"postProcessingStages":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/PublicApiPostProcessingStageDTO"}},"runnerId":{"type":"string"},"scanDefinition":{"type":"object","$ref":"#/components/schemas/PublicApiScanDefinitionSlim"},"scanTime":{"type":"string","format":"date-time"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/ScanStateDTO","description":"Scan lifecycle and outcome. Determined independently of errors; the error count alone does not determine the state."},"submitted":{"type":"string","format":"date-time"},"warnings":{"type":"integer","format":"int32"}},"required":["cloudUrl","created","id","state"]},"PublicApiCheckSlimDTO":{"type":"object","properties":{"evaluationStatus":{"type":"object","$ref":"#/components/schemas/EvaluationStatusDTO"},"id":{"type":"string"},"source":{"type":"object","$ref":"#/components/schemas/CheckSourceDTO","description":"Where the check was defined. Null for checks whose source is not known to Soda Cloud."}}},"EvaluationStatusDTO":{"type":"string","enum":["pass","warn","fail","notEvaluated","excluded"]},"CheckSourceDTO":{"type":"string","enum":["soda-sql","soda-core","soda-library","soda-cloud","dbt","soda-contract","data-standard","soda-metric-monitoring"]},"PublicApiPostProcessingStageDTO":{"type":"object","properties":{"ended":{"type":"string","format":"date-time"},"name":{"type":"object","$ref":"#/components/schemas/PublicApiPostProcessingStageTypeDTO"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/PublicApiPostProcessingStageStateDTO"}},"required":["name"]},"PublicApiPostProcessingStageTypeDTO":{"type":"string","enum":["diagnosticWarehouse"]},"PublicApiPostProcessingStageStateDTO":{"type":"string","enum":["ongoing","completed","failed"]},"PublicApiScanDefinitionSlim":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]}}}} ``` ## The PublicApiScanTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiScanTypeDTO":{"type":"string","enum":["default","runnerTest","cicd","discussion","checkDatasourceConnection","uiTest","observability","observabilityBackfilling","profiling","discovery","lineageDiscovery","contract","contractTest","generateContract","generateContractViaAutopilot","onboarding","checkDiagnosticsWarehouseConnection","dataStandards","dataStandardsTest"]}}}} ``` ## The PublicApiScansResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiScansResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ScansContentDTO"}},"nextCursor":{"type":"string"}},"required":["content"]},"ScansContentDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"created":{"type":"string","format":"date-time","description":"When Soda Cloud recorded the scan."},"datasets":{"type":"array","description":"The datasets the scan covered. Only filled in when `includeDatasets` is `true`.","items":{"type":"object","$ref":"#/components/schemas/DatasetSlimDTO"}},"ended":{"type":"string","format":"date-time"},"id":{"type":"string"},"runnerId":{"type":"string","description":"The runner that executed the scan. Null for scans that ran outside a runner."},"scanDefinition":{"type":"object","$ref":"#/components/schemas/PublicApiScanDefinitionSlim"},"scanReference":{"type":"string","description":"The reference the runner or the Soda Library reported for this scan run."},"scanTime":{"type":"string","format":"date-time","description":"The timestamp of the data the scan looked at, which can be older than when the scan ran. Results are sorted on this timestamp, newest first, and `from` and `to` filter on it."},"scanType":{"type":"object","$ref":"#/components/schemas/PublicApiScanTypeDTO","description":"The type of the scan definition this scan ran for, which is the type Soda Cloud shows for the scan."},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/ScanStateDTO"}}},"DatasetSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}}},"PublicApiScanDefinitionSlim":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiScanTypeDTO":{"type":"string","enum":["default","runnerTest","cicd","discussion","checkDatasourceConnection","uiTest","observability","observabilityBackfilling","profiling","discovery","lineageDiscovery","contract","contractTest","generateContract","generateContractViaAutopilot","onboarding","checkDiagnosticsWarehouseConnection","dataStandards","dataStandardsTest"]},"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]}}}} ``` ## The PublicApiSecretDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiSecretDTO":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}} ``` ## The PublicApiServiceAccountDefaultResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiServiceAccountDefaultResponsibilitiesResponse":{"type":"object","properties":{"assignments":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ServiceAccountDefaultAssignmentContentDTO"}}},"required":["assignments"]},"ServiceAccountDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/ServiceAccountRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The PublicApiServiceAccountResponsibilitiesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiServiceAccountResponsibilitiesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ServiceAccountResponsibilityContentDTO"}},"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"]},"ServiceAccountResponsibilityContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/ServiceAccountRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The PublicApiServiceAccountRolesResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiServiceAccountRolesResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ServiceAccountRoleContentDTO"}},"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"]},"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The PublicApiSetColumnAttributesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiSetColumnAttributesRequestDTO":{"type":"object","properties":{"columnAttributes":{"type":"object","$ref":"#/components/schemas/MapOfStringToMapOfStringTo_object","description":"Column name mapped to the attribute values to set on that column. A null value removes that attribute value from the column."}},"required":["columnAttributes"]},"MapOfStringToMapOfStringTo_object":{"type":"object","additionalProperties":true}}}} ``` ## The PublicApiSpuConsumptionResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiSpuConsumptionResponse":{"type":"object","properties":{"from":{"type":"string","format":"date-time"},"spusConsumed":{"type":"integer","format":"int64"},"to":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiSubmitMonitorResultFeedbackResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiSubmitMonitorResultFeedbackResponse":{"type":"object","properties":{"feedback":{"type":"object","$ref":"#/components/schemas/MonitorResultFeedbackDTO","description":"The feedback as it is now stored, including `submittedAt`, when Soda Cloud stored it."},"monitorId":{"type":"string","description":"The monitor the result belongs to. Use it in `GET /api/v1/checks/{checkId}/results`."},"resultId":{"type":"string"}},"required":["feedback","monitorId","resultId"]},"MonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly. Null on feedback that did not judge the classification."},"submittedAt":{"type":"string","format":"date-time","description":"When Soda Cloud stored the feedback."}}}}}} ``` ## The PublicApiSubscriptionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiSubscriptionDTO":{"type":"object","properties":{"endDate":{"type":"string","format":"date-time"},"startDate":{"type":"string","format":"date-time"}}}}}} ``` ## The PublicApiTestConnectionRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestConnectionRequestDTO":{"type":"object","properties":{"configurationFileContents":{"type":"string"},"runnerId":{"type":"string"}},"required":["configurationFileContents","runnerId"]}}}} ``` ## The PublicApiTestConnectionStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestConnectionStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiTestConnectionStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestConnectionStatusResponse":{"type":"object","properties":{"id":{"type":"string"},"message":{"type":"string"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/PublicApiTestConnectionStateDTO"}},"required":["id","state"]},"PublicApiTestConnectionStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiTestDataStandardRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestDataStandardRequestDTO":{"type":"object","properties":{"contents":{"type":"string"},"datasetId":{"type":"string"}},"required":["contents","datasetId"]}}}} ``` ## The PublicApiTestDataStandardResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestDataStandardResponse":{"type":"object","properties":{"scanId":{"type":"string"}}}}}} ``` ## The PublicApiTestLoginResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiTestLoginResponse":{"type":"object","properties":{"organisationName":{"type":"string"}}}}}} ``` ## The PublicApiUpdateAttributeRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateAttributeRequestDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"label":{"type":"string"}}}}}} ``` ## The PublicApiUpdateAttributeResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateAttributeResponse":{"type":"object","properties":{"attribute":{"type":"object","$ref":"#/components/schemas/AttributeContentDTO"}},"required":["attribute"]},"AttributeContentDTO":{"type":"object","properties":{"allowedValues":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"resourceType":{"type":"object","$ref":"#/components/schemas/AttributeResourceTypeDTO"},"type":{"type":"object","$ref":"#/components/schemas/AttributeTypeDTO"}},"required":["id","label","name","resourceType","type"]},"AttributeResourceTypeDTO":{"type":"string","enum":["dataset","check","column","dataStandard","dataProduct"]},"AttributeTypeDTO":{"type":"string","enum":["text","number","checkbox","datetime","singleSelect","multiSelect"]}}}} ``` ## The PublicApiUpdateColumnMetricMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"}}}}}} ``` ## The PublicApiUpdateColumnMetricMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]},"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"]}}}} ``` ## The PublicApiUpdateCustomSqlMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"}}}}}} ``` ## The PublicApiUpdateCustomSqlMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]},"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"}}}}}} ``` ## The PublicApiUpdateDataProductResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDataProductResponse":{"type":"object","properties":{"dataProduct":{"type":"object","$ref":"#/components/schemas/DataProductContentDTO"},"warnings":{"type":"array","items":{"type":"string"}}},"required":["dataProduct","warnings"]},"DataProductContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"cloudUrl":{"type":"string"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"description":{"type":"string"},"health":{"type":"object","$ref":"#/components/schemas/DataProductHealthContentDTO"},"id":{"type":"string"},"label":{"type":"string","description":"The `name` of the data product YAML."},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string","description":"The `key` of the data product YAML. It is unique in the organization and cannot change. Use it as `dataProductName` in the paths."},"owner":{"type":"object","$ref":"#/components/schemas/DataProductOwnerContentDTO"},"url":{"type":"string"}},"required":["attributes","cloudUrl","contents","created","health","id","label","lastUpdated","name","owner"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataProductHealthContentDTO":{"type":"object","properties":{"evidenceCoverage":{"type":"integer","format":"int32","description":"Percentage, 0 to 100, of the inputs that are not notVerified. Absent when the product has no inputs."},"inputs":{"type":"object","$ref":"#/components/schemas/DataProductHealthInputCountsContentDTO"},"lastEvaluated":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/DataProductHealthStateContentDTO"}},"required":["inputs","state"]},"DataProductHealthInputCountsContentDTO":{"type":"object","properties":{"atRisk":{"type":"integer","format":"int32"},"healthy":{"type":"integer","format":"int32"},"noAccess":{"type":"integer","format":"int32","description":"Inputs whose dataset the caller cannot view, counted for the caller only. They are also counted in healthy, atRisk, unhealthy or notVerified, so other callers see the same state counts but can see a different number here."},"notFound":{"type":"integer","format":"int32","description":"Inputs whose dataset does not exist. Also counted in notVerified: healthy + atRisk + unhealthy + notVerified equals the number of inputs."},"notVerified":{"type":"integer","format":"int32"},"unhealthy":{"type":"integer","format":"int32"}},"required":["atRisk","healthy","noAccess","notFound","notVerified","unhealthy"]},"DataProductHealthStateContentDTO":{"type":"string","enum":["healthy","atRisk","unhealthy","notVerified","incomplete"]},"DataProductOwnerContentDTO":{"type":"object","properties":{"email":{"type":"string"},"state":{"type":"object","$ref":"#/components/schemas/DataProductOwnerStateContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/DataProductOwnerTypeContentDTO"},"user":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"userGroup":{"type":"object","$ref":"#/components/schemas/UserGroupContentBasicDTO"},"userGroupId":{"type":"string"}},"required":["state","type"]},"DataProductOwnerStateContentDTO":{"type":"string","enum":["linked","notFound"]},"DataProductOwnerTypeContentDTO":{"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The PublicApiUpdateDataStandardResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDataStandardResponse":{"type":"object","properties":{"dataStandard":{"type":"object","$ref":"#/components/schemas/DataStandardContentDTO"}}},"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiUpdateDataStandardStatusRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDataStandardStatusRequestDTO":{"type":"object","properties":{"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["status"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiUpdateDataStandardStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDataStandardStatusResponse":{"type":"object","properties":{"dataStandard":{"type":"object","$ref":"#/components/schemas/DataStandardContentDTO"}}},"DataStandardContentDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"checkResults":{"type":"object","$ref":"#/components/schemas/DataStandardCheckResultsDTO"},"cloudUrl":{"type":"string"},"compliance":{"type":"integer","format":"int64"},"contents":{"type":"string"},"created":{"type":"string","format":"date-time"},"datasetCount":{"type":"integer","format":"int32"},"description":{"type":"string"},"id":{"type":"string"},"label":{"type":"string"},"lastScanTime":{"type":"string","format":"date-time"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"},"owners":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasetOwnerDTO"}},"schedule":{"type":"object","$ref":"#/components/schemas/DataStandardScheduleDTO"},"scope":{"type":"object","$ref":"#/components/schemas/DataStandardScopeDTO"},"status":{"type":"object","$ref":"#/components/schemas/DataStandardStatusDTO"}},"required":["id"]},"MapOfStringTo_object":{"type":"object","additionalProperties":true},"DataStandardCheckResultsDTO":{"type":"object","properties":{"failingCount":{"type":"integer","format":"int32"},"notEvaluatedCount":{"type":"integer","format":"int32"},"passingCount":{"type":"integer","format":"int32"},"warningCount":{"type":"integer","format":"int32"}}},"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":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]},"DataStandardScheduleDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}},"DataStandardScopeDTO":{"type":"object","properties":{"rules":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeRuleDTO"}}}},"DataStandardScopeRuleDTO":{"type":"object","properties":{"attributesFilter":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"},"datasourceId":{"type":"string","description":"Id of the datasource the dataset lives in. Leave it out to match datasets in any datasource."},"name":{"type":"string","description":"Name of the dataset, matched as a pattern. `customers` matches that name and nothing else, `customers*` matches names starting with `customers`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `cust*ers`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any name."},"schema":{"type":"string","description":"Schema the dataset lives in, matched as a pattern. `analytics` matches that schema and nothing else, `analytics*` matches schemas starting with `analytics`, `*_raw` those ending with `_raw`, and `*core*` those containing `core`. A `*` in the middle, as in `an*ics`, is rejected with a 400, and you cannot match a literal `*`. Leave the field out, or set it to blank or just `*`, to match any schema."}}},"DataStandardScopeAttributeFilterDTO":{"type":"object","properties":{"attributeName":{"type":"string"},"booleanValue":{"type":"boolean"},"date":{"type":"string","format":"date-time"},"filters":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterDTO"}},"type":{"type":"object","$ref":"#/components/schemas/DataStandardScopeAttributeFilterTypeDTO"},"value":{"type":"string"}},"required":["type"]},"DataStandardScopeAttributeFilterTypeDTO":{"type":"string","enum":["equals","contains","and","or"]},"DataStandardStatusDTO":{"type":"string","enum":["draft","active","paused","invalid"]}}}} ``` ## The PublicApiUpdateDatasetDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasetDTO":{"type":"object","properties":{"attributes":{"type":"object","$ref":"#/components/schemas/MapOfStringTo_object"},"computeWarehouseOverride":{"type":"object","$ref":"#/components/schemas/UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO"},"dataDelaySeconds":{"type":"integer","format":"int32"},"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","recordAnomalyScore"]},"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"}}}}}} ``` ## The PublicApiUpdateDatasetDefaultResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasetDefaultResponsibilitiesRequestDTO":{"type":"object","properties":{"assignments":{"type":"array","description":"Replaces the whole list of default assignments. Leave it out to keep the assignments that are configured now, or send an empty list to remove all of them.","items":{"type":"object","$ref":"#/components/schemas/DatasetDefaultAssignmentRequestDTO"}},"defaultOwnerRoleId":{"type":"string","description":"Id of the dataset role to grant to the owner of a newly created dataset. Leave it out to keep the role that is configured now."}}},"DatasetDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateDatasetOwnerRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The PublicApiUpdateDatasetResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"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"]}}}} ``` ## The PublicApiUpdateDatasetRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The PublicApiUpdateDatasetsMetricMonitoringRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasetsMetricMonitoringRequestDTO":{"type":"object","properties":{"datasetIds":{"type":"array","description":"Ids of the datasets to configure. Additive with `datasetQualifiedNames`.","items":{"type":"string"}},"datasetQualifiedNames":{"type":"array","description":"Qualified names of the datasets to configure, for example `my_datasource/my_schema/my_table`. Additive with `datasetIds`.","items":{"type":"string"}},"metricMonitoring":{"type":"object","$ref":"#/components/schemas/UpdateDatasetMetricMonitoringConfigurationRequestDTO","description":"The metric monitoring configuration to apply to every selected dataset."}},"required":["metricMonitoring"]},"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","recordAnomalyScore"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]}}}} ``` ## The PublicApiUpdateDatasetsMetricMonitoringStatusResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasetsMetricMonitoringStatusResponse":{"type":"object","properties":{"datasets":{"type":"array","description":"One entry per selected dataset. Only present once the operation has finished.","items":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasetsMetricMonitoringStatusResponse_DatasetMetricMonitoringUpdateOutcomeDTO"}},"ended":{"type":"string","format":"date-time"},"operationId":{"type":"string"},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/PublicApiMetricMonitoringUpdateOperationStateDTO"}}},"PublicApiUpdateDatasetsMetricMonitoringStatusResponse_DatasetMetricMonitoringUpdateOutcomeDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"reason":{"type":"string","description":"Why the configuration was not applied. Null when the status is `applied`."},"status":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetMetricMonitoringUpdateStatusDTO"}}},"PublicApiDatasetMetricMonitoringUpdateStatusDTO":{"type":"string","enum":["applied","skipped","failed"]},"PublicApiMetricMonitoringUpdateOperationStateDTO":{"type":"string","enum":["queued","processing","completed","failed","cancelled"]}}}} ``` ## The PublicApiUpdateDatasetsMetricMonitoringStatusResponse\_DatasetMetricMonitoringUpdateOutcomeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasetsMetricMonitoringStatusResponse_DatasetMetricMonitoringUpdateOutcomeDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"datasetQualifiedName":{"type":"string"},"reason":{"type":"string","description":"Why the configuration was not applied. Null when the status is `applied`."},"status":{"type":"object","$ref":"#/components/schemas/PublicApiDatasetMetricMonitoringUpdateStatusDTO"}}},"PublicApiDatasetMetricMonitoringUpdateStatusDTO":{"type":"string","enum":["applied","skipped","failed"]}}}} ``` ## The PublicApiUpdateDatasourceDefaultResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceDefaultResponsibilitiesRequestDTO":{"type":"object","properties":{"assignments":{"type":"array","description":"Replaces the whole list of default assignments. Leave it out to keep the assignments that are configured now, or send an empty list to remove all of them.","items":{"type":"object","$ref":"#/components/schemas/DatasourceDefaultAssignmentRequestDTO"}},"defaultOwnerRoleId":{"type":"string","description":"Id of the datasource role to grant to the owner of a newly created datasource. Leave it out to keep the role that is configured now."}}},"DatasourceDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO":{"type":"object","properties":{"configurationFileContents":{"type":"string"},"enabled":{"type":"boolean"},"failedRowsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_FailedRowsConfigurationRequestDTO"},"reuseDatasource":{"type":"boolean"},"scanAndResultsConfiguration":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ScanAndResultsConfigurationRequestDTO"},"schema":{"type":"string"},"tableNameTemplate":{"type":"string"}}},"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_FailedRowsConfigurationRequestDTO":{"type":"object","properties":{"actionButton":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ActionButtonRequestDTO"},"enabled":{"type":"boolean"},"exposeQueries":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"locationMessage":{"type":"string"},"maxRowCount":{"type":"integer","format":"int32"}}},"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ActionButtonRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"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"]},"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ScanAndResultsConfigurationRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO\_ActionButtonRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ActionButtonRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO\_FailedRowsConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_FailedRowsConfigurationRequestDTO":{"type":"object","properties":{"actionButton":{"type":"object","$ref":"#/components/schemas/PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ActionButtonRequestDTO"},"enabled":{"type":"boolean"},"exposeQueries":{"type":"boolean"},"failedRowSamples":{"type":"object","$ref":"#/components/schemas/FailedRowSamplesDTO"},"failedRowsCollectionStrategy":{"type":"object","$ref":"#/components/schemas/FailedRowsCollectionStrategyDTO"},"locationMessage":{"type":"string"},"maxRowCount":{"type":"integer","format":"int32"}}},"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ActionButtonRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"title":{"type":"string"},"url":{"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"]}}}} ``` ## The PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO\_ScanAndResultsConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceDiagnosticsWarehouseRequestDTO_ScanAndResultsConfigurationRequestDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}}}}}} ``` ## The PublicApiUpdateDatasourceRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceRequestDTO":{"type":"object","properties":{"configurationFileContents":{"type":"string"},"label":{"type":"string"},"ownerId":{"type":"string"},"runnerId":{"type":"string"}}}}}} ``` ## The PublicApiUpdateDatasourceResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceResponse":{"type":"object","properties":{"datasource":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceDTO"}}},"PublicApiDatasourceDTO":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time"},"id":{"type":"string"},"label":{"type":"string"},"name":{"type":"string"},"owner":{"type":"object","$ref":"#/components/schemas/UserContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/PublicApiDatasourceTypeDTO"},"updatedAt":{"type":"string","format":"date-time"},"version":{"type":"object","$ref":"#/components/schemas/ModelVersionDTO","description":"The Soda model version of the datasource: `3` or `4`."}}},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]},"PublicApiDatasourceTypeDTO":{"type":"string","enum":["bigquery","mysql","mariadb","postgres","snowflake","dask","spark","sparkdf","redshift","duckdb","presto","oracle","athena","trino","dremio","vertica","denodo","db2","db2z","sqlserver","databricks","synapse","fabric","hana","salesforce"]},"ModelVersionDTO":{"type":"string","enum":["3","4"]}}}} ``` ## The PublicApiUpdateDatasourceResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceResponsibilitiesRequestDTO":{"type":"object","properties":{"responsibilities":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/DatasourceResponsibilityContentRequestDTO"}}},"required":["responsibilities"]},"DatasourceResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateDatasourceRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateDatasourceRoleResponse":{"type":"object","properties":{"datasourceRole":{"type":"object","$ref":"#/components/schemas/DatasourceRoleContentDTO"}},"required":["datasourceRole"]},"DatasourceRoleContentDTO":{"type":"object","properties":{"createDatasets":{"type":"boolean"},"deleteDatasource":{"type":"boolean"},"id":{"type":"string"},"manageDatasourceSettings":{"type":"boolean"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewDatasource":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The PublicApiUpdateGlobalResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateGlobalResponsibilitiesRequestDTO":{"type":"object","properties":{"responsibilities":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/GlobalResponsibilityContentRequestDTO"}}},"required":["responsibilities"]},"GlobalResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateGlobalRoleResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateGlobalRoleResponse":{"type":"object","properties":{"globalRole":{"type":"object","$ref":"#/components/schemas/GlobalRoleContentDTO"}},"required":["globalRole"]},"GlobalRoleContentDTO":{"type":"object","properties":{"admin":{"type":"boolean","description":"True for the built-in Admin role. It grants every right in the organization, reports every permission below as true, and can be neither updated nor deleted."},"createAgreements":{"type":"boolean"},"createApiKeys":{"type":"boolean"},"createNewDatasourcesAndDatasets":{"type":"boolean"},"description":{"type":"string"},"id":{"type":"string"},"manageAttributes":{"type":"boolean"},"manageDataProducts":{"type":"boolean"},"manageDataStandards":{"type":"boolean"},"manageDatasourcesAndRunners":{"type":"boolean"},"manageNotificationRules":{"type":"boolean"},"manageOrganisationSettings":{"type":"boolean"},"manageScanDefinitions":{"type":"boolean"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The PublicApiUpdateIncidentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateIncidentDTO":{"type":"object","properties":{"addMonitorResultIds":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"leadId":{"type":"string"},"removeMonitorResultIds":{"type":"array","items":{"type":"string"}},"resolutionNotes":{"type":"string"},"severity":{"type":"object","$ref":"#/components/schemas/IncidentSeverityDTO"},"status":{"type":"object","$ref":"#/components/schemas/IncidentStatusDTO"},"title":{"type":"string"}}},"IncidentSeverityDTO":{"type":"string","enum":["minor","major","critical"]},"IncidentStatusDTO":{"type":"string","enum":["reported","investigating","fixing","resolved"]}}}} ``` ## The PublicApiUpdateMonitorRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateMonitorRequestDTO":{"type":"object","properties":{"columnName":{"type":"string","description":"Custom SQL monitors only: the column the monitor is listed under. Send null to list the monitor on the dataset instead of on a column."},"configuration":{"type":"object","$ref":"#/components/schemas/MonitorConfigurationUpdateDTO","description":"The settings to change. Only the settings you send are changed, the others keep their current value."},"name":{"type":"string","description":"Custom SQL monitors only: the name of the monitor. Soda generates dataset and column metric monitor names, so they cannot be changed."}}},"MonitorConfigurationUpdateDTO":{"type":"object","properties":{"groupByColumnNames":{"type":"array","description":"Custom SQL monitors only: the columns the query result is grouped by.","items":{"type":"string"}},"groupByColumns":{"type":"array","description":"Column metric monitors only: the columns the metric is grouped by.","items":{"type":"object","$ref":"#/components/schemas/GroupByColumnConfigurationDTO"}},"resultMetric":{"type":"string","description":"Custom SQL monitors only: the name of the query result column that holds the measured value."},"sqlQuery":{"type":"string","description":"Custom SQL monitors only: the query that produces the measured value."},"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"}}}}}} ``` ## The PublicApiUpdateMonitorResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateMonitorResponse":{"type":"object","properties":{"columnMetricMonitor":{"type":"object","$ref":"#/components/schemas/ColumnMetricMonitorDTO","description":"Set when the updated monitor is a column metric monitor."},"customSqlMetricMonitor":{"type":"object","$ref":"#/components/schemas/CustomMetricMonitorDTO","description":"Set when the updated monitor is a custom SQL monitor."},"datasetId":{"type":"string","description":"The dataset the monitor belongs to, resolved from the monitor id."},"datasetMetricMonitor":{"type":"object","$ref":"#/components/schemas/DatasetMetricMonitorConfigurationDTO","description":"Set when the updated monitor is a dataset metric monitor."},"monitorId":{"type":"string"}},"required":["datasetId","monitorId"]},"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","recordAnomalyScore"]}}}} ``` ## The PublicApiUpdateSecretRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateSecretRequestDTO":{"type":"object","properties":{"encryptedValue":{"type":"string"},"encryptionKey":{"type":"string"}},"required":["encryptedValue","encryptionKey"]}}}} ``` ## The PublicApiUpdateSecretResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateSecretResponse":{"type":"object","properties":{"secret":{"type":"object","$ref":"#/components/schemas/PublicApiSecretDTO"}}},"PublicApiSecretDTO":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"id":{"type":"string"},"lastUpdated":{"type":"string","format":"date-time"},"name":{"type":"string"}}}}}} ``` ## The PublicApiUpdateServiceAccountDefaultResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateServiceAccountDefaultResponsibilitiesRequestDTO":{"type":"object","properties":{"assignments":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ServiceAccountDefaultAssignmentRequestDTO"}}},"required":["assignments"]},"ServiceAccountDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateServiceAccountResponsibilitiesRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateServiceAccountResponsibilitiesRequestDTO":{"type":"object","properties":{"responsibilities":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/ServiceAccountResponsibilityContentRequestDTO"}}},"required":["responsibilities"]},"ServiceAccountResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The PublicApiUpdateUserGroupRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUpdateUserGroupRequestDTO":{"type":"object","properties":{"userIds":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PublicApiUserGroupsResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUserGroupsResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/UserGroupContentDTO"}},"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"]},"UserGroupContentDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"},"users":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/UserContentDTO"}}},"required":["label","name","userGroupId","users"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]}}}} ``` ## The PublicApiUsersResponse object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiUsersResponse":{"type":"object","properties":{"content":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/UserListItemDTO"}},"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"]},"UserListItemDTO":{"type":"object","properties":{"email":{"type":"string"},"enabled":{"type":"boolean"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","enabled","userId"]}}}} ``` ## The PublicApiVerifyContractRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"PublicApiVerifyContractRequestDTO":{"type":"object","properties":{"checkFilters":{"type":"array","description":"Limits the verification to some of the checks of the contract. Each entry names a field and the values to match. Currently the only field is `scope`, and each combination of field and `negate` may appear once. Use the value `base` for the checks that do not belong to any scope; any other value must be a scope declared in the contract. A check matches an entry when its value is any of the listed values. Set `negate: true` to match every value except the listed ones. A check must match every entry, and when `checkPaths` is also given, it must match `checkPaths` too. Example: `[{\"field\": \"scope\", \"values\": [\"eu\", \"base\"]}]` verifies the checks of the `eu` scope and the checks without a scope.","items":{"type":"object","$ref":"#/components/schemas/PublicApiContractCheckFilterDTO"}},"checkPaths":{"type":"array","items":{"type":"string"}}}},"PublicApiContractCheckFilterDTO":{"type":"object","properties":{"field":{"type":"object","$ref":"#/components/schemas/PublicApiContractCheckFilterFieldDTO"},"negate":{"type":"boolean"},"values":{"type":"array","items":{"type":"string"}}}},"PublicApiContractCheckFilterFieldDTO":{"type":"string","enum":["scope"]}}}} ``` ## The RadAxisDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]}}}} ``` ## The RadAxisResolutionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]}}}} ``` ## The RadAxisSemanticDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]}}}} ``` ## The RadBucketCountsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]}}}} ``` ## The RadBucketDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]}}}} ``` ## The RadColumnEffectDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]}}}} ``` ## The RadExplanationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadExplanationDTO":{"type":"object","properties":{"columnEffects":{"type":"array","description":"Columns whose values shifted across the whole partition. Empty when no column stood out.","items":{"type":"object","$ref":"#/components/schemas/RadColumnEffectDTO"}},"segmentEffects":{"type":"array","description":"Columns whose values shifted more within a slice of rows than across the whole partition. Empty when no slice stood out.","items":{"type":"object","$ref":"#/components/schemas/RadSegmentEffectDTO"}}},"required":["columnEffects","segmentEffects"]},"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]}}}} ``` ## The RadFeatureKindDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]}}}} ``` ## The RadOtherCategoriesDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]}}}} ``` ## The RadPartitionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadPartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"rowCount":{"type":"integer","format":"int32","description":"Rows in the whole partition, not in the sample the bucket counts are taken from. 0 means the partition was empty."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]}}}} ``` ## The RadRangeClosedDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]}}}} ``` ## The RadReferencePartitionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadReferencePartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]}}}} ``` ## The RadRowCountsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]}}}} ``` ## The RadRunPhaseDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadRunPhaseDTO":{"type":"string","enum":["skipped","warmingUp","steady"]}}}} ``` ## The RadSegmentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]}}}} ``` ## The RadSegmentEffectDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]}}}} ``` ## The RadSegmentOperatorDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]}}}} ``` ## The RadSegmentRangeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]}}}} ``` ## The RadValueDistributionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]}}}} ``` ## The RcaAssetTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaAssetTypeDTO":{"type":"string","enum":["dataset","datasource"]}}}} ``` ## The RcaConfidenceDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaConfidenceDTO":{"type":"string","enum":["high","medium","low"]}}}} ``` ## The RcaNodeStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaNodeStatusDTO":{"type":"string","enum":["rootCause","affected","healthy"]}}}} ``` ## The RcaPriorityDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaPriorityDTO":{"type":"string","enum":["low","medium","high","urgent"]}}}} ``` ## The RcaReportStatusDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaReportStatusDTO":{"type":"string","enum":["completed","partial","inconclusive","failed"]}}}} ``` ## The RcaResourceTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RcaResourceTypeDTO":{"type":"string","enum":["dataset","datasource","check","checkResult"]}}}} ``` ## The RecordAnomalyDetectionDiagnosticsDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RecordAnomalyDetectionDiagnosticsDTO":{"type":"object","properties":{"explanation":{"type":"object","$ref":"#/components/schemas/RadExplanationDTO","description":"Why the partition looked unusual. Null when the run produced no explanation."},"monitoredColumns":{"type":"array","description":"The columns this run compared. Empty when it compared none, as on a run without a score.","items":{"type":"string"}},"partition":{"type":"object","$ref":"#/components/schemas/RadPartitionDTO"},"reference":{"type":"object","$ref":"#/components/schemas/RadReferencePartitionDTO","description":"The past partition that looked most like this one. The explanation compares against it. Null when no past partition was selected, as on a `skipped` run."},"runPhase":{"type":"object","$ref":"#/components/schemas/RadRunPhaseDTO","description":"`skipped`: the run produced no score, for example because the partition was empty, had too few rows, or had too few past partitions to compare with. `warmingUp`: fewer past partitions are available than the full window, so a score is less settled. `steady`: the full window of past partitions is available."}},"required":["monitoredColumns","partition","runPhase"]},"RadExplanationDTO":{"type":"object","properties":{"columnEffects":{"type":"array","description":"Columns whose values shifted across the whole partition. Empty when no column stood out.","items":{"type":"object","$ref":"#/components/schemas/RadColumnEffectDTO"}},"segmentEffects":{"type":"array","description":"Columns whose values shifted more within a slice of rows than across the whole partition. Empty when no slice stood out.","items":{"type":"object","$ref":"#/components/schemas/RadSegmentEffectDTO"}}},"required":["columnEffects","segmentEffects"]},"RadColumnEffectDTO":{"type":"object","properties":{"column":{"type":"string"},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"}},"required":["column","distribution","kind"]},"RadValueDistributionDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the `min` and `max` bucket bounds of a `temporal` column, which are in seconds. Null for the other kinds."},"buckets":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/RadBucketDTO"}},"missing":{"type":"object","$ref":"#/components/schemas/RadBucketCountsDTO","description":"Rows where the column has no value. Null when there are none."},"other":{"type":"object","$ref":"#/components/schemas/RadOtherCategoriesDTO","description":"Rows in the categories that are not listed in `buckets`. Only set for a `categorical` column with more categories than are listed."}},"required":["buckets"]},"RadAxisDTO":{"type":"object","properties":{"resolution":{"type":"object","$ref":"#/components/schemas/RadAxisResolutionDTO","description":"The finest unit seen in the source column's values. `day` means a date column. Null for a duration."},"semantic":{"type":"object","$ref":"#/components/schemas/RadAxisSemanticDTO"},"timezone":{"type":"string","description":"The timezone of the source column. Null for a duration."}},"required":["semantic"]},"RadAxisResolutionDTO":{"type":"string","enum":["day","hour","minute","second","millisecond","microsecond","nanosecond"]},"RadAxisSemanticDTO":{"type":"string","enum":["secondsFromPartitionStart","unixSeconds","secondsDuration"]},"RadBucketDTO":{"type":"object","properties":{"category":{"type":"string","description":"The category this bucket counts. Only set for a `categorical` column."},"max":{"type":"number","description":"The upper bound of this bucket, inclusive. Null for a `categorical` column."},"min":{"type":"number","description":"The lower bound of this bucket, exclusive except on the first bucket. Null for a `categorical` column."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadBucketCountsDTO":{"type":"object","properties":{"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["presentCount","presentProportion","referenceCount","referenceProportion"]},"RadOtherCategoriesDTO":{"type":"object","properties":{"categoryCount":{"type":"integer","format":"int32","description":"How many categories this bucket folds together."},"presentCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the checked partition."},"presentProportion":{"type":"number","description":"This bucket's share of the checked partition's sample, from 0 to 1."},"referenceCount":{"type":"integer","format":"int32","description":"Rows in this bucket, counted in a sample of the reference partition."},"referenceProportion":{"type":"number","description":"This bucket's share of the reference partition's sample, from 0 to 1."}},"required":["categoryCount","presentCount","presentProportion","referenceCount","referenceProportion"]},"RadFeatureKindDTO":{"type":"string","enum":["categorical","numeric","temporal"]},"RadSegmentEffectDTO":{"type":"object","properties":{"column":{"type":"string","description":"The column whose values shifted within the segment."},"distribution":{"type":"object","$ref":"#/components/schemas/RadValueDistributionDTO"},"kind":{"type":"object","$ref":"#/components/schemas/RadFeatureKindDTO"},"rowCounts":{"type":"object","$ref":"#/components/schemas/RadRowCountsDTO"},"segment":{"type":"object","$ref":"#/components/schemas/RadSegmentDTO"}},"required":["column","distribution","kind","rowCounts","segment"]},"RadRowCountsDTO":{"type":"object","properties":{"present":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the checked partition."},"reference":{"type":"integer","format":"int32","description":"Rows in the segment, counted in a sample of the reference partition."}},"required":["present","reference"]},"RadSegmentDTO":{"type":"object","properties":{"axis":{"type":"object","$ref":"#/components/schemas/RadAxisDTO","description":"How to read the range bounds when the column is a timestamp. Null otherwise."},"column":{"type":"string"},"operator":{"type":"object","$ref":"#/components/schemas/RadSegmentOperatorDTO"},"range":{"type":"object","$ref":"#/components/schemas/RadSegmentRangeDTO","description":"The bounds the column falls within. Only set for `range`."},"values":{"type":"array","description":"The categories the column takes: one for `eq`, several for `in`. Null for the other operators.","items":{"type":"string"}}},"required":["column","operator"]},"RadSegmentOperatorDTO":{"type":"string","enum":["eq","in","range","isMissing"]},"RadSegmentRangeDTO":{"type":"object","properties":{"closed":{"type":"object","$ref":"#/components/schemas/RadRangeClosedDTO","description":"Which of the bounds belong to the range."},"max":{"type":"number"},"min":{"type":"number"}},"required":["closed"]},"RadRangeClosedDTO":{"type":"string","enum":["left","right","both","neither"]},"RadPartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"rowCount":{"type":"integer","format":"int32","description":"Rows in the whole partition, not in the sample the bucket counts are taken from. 0 means the partition was empty."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadReferencePartitionDTO":{"type":"object","properties":{"end":{"type":"string","format":"date-time","description":"The end of the partition, exclusive."},"start":{"type":"string","format":"date-time"}},"required":["end","start"]},"RadRunPhaseDTO":{"type":"string","enum":["skipped","warmingUp","steady"]}}}} ``` ## The ReferenceDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ReferenceDiffDiagnosticsV4":{"type":"object","properties":{"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The ResponsibilityTypeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The RowCountDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RowCountDiagnosticsV4":{"type":"object","properties":{"checkRowsTested":{"type":"integer","format":"int32"},"datasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The RowCountDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RowCountDiffDiagnosticsV4":{"type":"object","properties":{"rowCountDiff":{"type":"integer","format":"int32"},"rowCountDiffPercent":{"type":"number"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The RowsDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"RowsDiffDiagnosticsV4":{"type":"object","properties":{"changed":{"type":"integer","format":"int32"},"diffCount":{"type":"integer","format":"int32"},"diffPercent":{"type":"number"},"exclusiveInSource":{"type":"integer","format":"int32"},"exclusiveInTarget":{"type":"integer","format":"int32"},"nullKeyRowsSource":{"type":"integer","format":"int32"},"nullKeyRowsTarget":{"type":"integer","format":"int32"},"sourceCheckRowsTested":{"type":"integer","format":"int32"},"sourceDatasetRowsTested":{"type":"integer","format":"int32"},"targetCheckRowsTested":{"type":"integer","format":"int32"},"targetDatasetRowsTested":{"type":"integer","format":"int32"}}}}}} ``` ## The ScanStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]}}}} ``` ## The ScansContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ScansContentDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"created":{"type":"string","format":"date-time","description":"When Soda Cloud recorded the scan."},"datasets":{"type":"array","description":"The datasets the scan covered. Only filled in when `includeDatasets` is `true`.","items":{"type":"object","$ref":"#/components/schemas/DatasetSlimDTO"}},"ended":{"type":"string","format":"date-time"},"id":{"type":"string"},"runnerId":{"type":"string","description":"The runner that executed the scan. Null for scans that ran outside a runner."},"scanDefinition":{"type":"object","$ref":"#/components/schemas/PublicApiScanDefinitionSlim"},"scanReference":{"type":"string","description":"The reference the runner or the Soda Library reported for this scan run."},"scanTime":{"type":"string","format":"date-time","description":"The timestamp of the data the scan looked at, which can be older than when the scan ran. Results are sorted on this timestamp, newest first, and `from` and `to` filter on it."},"scanType":{"type":"object","$ref":"#/components/schemas/PublicApiScanTypeDTO","description":"The type of the scan definition this scan ran for, which is the type Soda Cloud shows for the scan."},"started":{"type":"string","format":"date-time"},"state":{"type":"object","$ref":"#/components/schemas/ScanStateDTO"}}},"DatasetSlimDTO":{"type":"object","properties":{"cloudUrl":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"qualifiedName":{"type":"string"}}},"PublicApiScanDefinitionSlim":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"PublicApiScanTypeDTO":{"type":"string","enum":["default","runnerTest","cicd","discussion","checkDatasourceConnection","uiTest","observability","observabilityBackfilling","profiling","discovery","lineageDiscovery","contract","contractTest","generateContract","generateContractViaAutopilot","onboarding","checkDiagnosticsWarehouseConnection","dataStandards","dataStandardsTest"]},"ScanStateDTO":{"type":"string","enum":["queuing","executing","started","cancelationRequested","timeOutRequested","canceled","timedOut","failed","completedWithErrors","completedWithFailures","completedWithWarnings","completed"]}}}} ``` ## The SchemaDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SchemaDiagnosticsV4":{"type":"object","properties":{"actual":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}},"expected":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiagnosticsV4_Column"}}}},"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The SchemaDiagnosticsV4\_Column object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SchemaDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The SchemaDiffDiagnosticsV4 object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SchemaDiffDiagnosticsV4":{"type":"object","properties":{"missingInSource":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"missingInTarget":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_Column"}},"typeMismatch":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/SchemaDiffDiagnosticsV4_TypeMismatch"}}}},"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}},"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}}}}} ``` ## The SchemaDiffDiagnosticsV4\_Column object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SchemaDiffDiagnosticsV4_Column":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}}}}}} ``` ## The SchemaDiffDiagnosticsV4\_TypeMismatch object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SchemaDiffDiagnosticsV4_TypeMismatch":{"type":"object","properties":{"sourceColumn":{"type":"string"},"sourceType":{"type":"string"},"targetColumn":{"type":"string"},"targetType":{"type":"string"}}}}}} ``` ## The ServiceAccountDefaultAssignmentContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ServiceAccountDefaultAssignmentContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/ServiceAccountRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The ServiceAccountDefaultAssignmentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ServiceAccountDefaultAssignmentRequestDTO":{"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"]}}}} ``` ## The ServiceAccountResponsibilityContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ServiceAccountResponsibilityContentDTO":{"type":"object","properties":{"role":{"type":"object","$ref":"#/components/schemas/ServiceAccountRoleContentDTO"},"type":{"type":"object","$ref":"#/components/schemas/ResponsibilityTypeDTO"},"userGroupId":{"type":"string"},"userId":{"type":"string"}},"required":["role","type"]},"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]},"ResponsibilityTypeDTO":{"type":"string","enum":["user","userGroup"]}}}} ``` ## The ServiceAccountResponsibilityContentRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ServiceAccountResponsibilityContentRequestDTO":{"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"]}}}} ``` ## The ServiceAccountRoleContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ServiceAccountRoleContentDTO":{"type":"object","properties":{"deleteServiceAccount":{"type":"boolean","description":"Grants deactivating and activating the service account; Soda Cloud does not delete service accounts."},"editServiceAccount":{"type":"boolean"},"id":{"type":"string"},"managePermissions":{"type":"boolean"},"name":{"type":"string"},"viewServiceAccount":{"type":"boolean"}},"required":["id","name"]}}}} ``` ## The SkeletonContractOperationStateDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SkeletonContractOperationStateDTO":{"type":"string","enum":["ongoing","completed","failed","canceled"]}}}} ``` ## The SubmitMonitorResultFeedbackDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"SubmitMonitorResultFeedbackDTO":{"type":"object","properties":{"isCorrectlyClassified":{"type":"boolean","description":"Whether the anomaly detection model classified this result correctly."}},"required":["isCorrectlyClassified"]}}}} ``` ## The ThresholdConditionDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ThresholdConditionDTO":{"type":"string","enum":["greaterThan","lessThan"]}}}} ``` ## The ThresholdStrategyDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ThresholdStrategyDTO":{"type":"object","properties":{"isLowerBoundEnabled":{"type":"boolean"},"isUpperBoundEnabled":{"type":"boolean"}},"required":["isLowerBoundEnabled","isUpperBoundEnabled"]}}}} ``` ## The UnitOfTimeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UnitOfTimeDTO":{"type":"string","enum":["hours","days","weeks"]}}}} ``` ## The UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]}}}} ``` ## The UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO\_WarehouseConfigurationDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UpdateDatasetComputeWarehouseOverrideConfigurationRequestDTO_WarehouseConfigurationDTO":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]}}}} ``` ## The UpdateDatasetDiagnosticsWarehouseConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"}}}}}} ``` ## The UpdateDatasetMetricMonitoringConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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","recordAnomalyScore"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]}}}} ``` ## The UpdateDatasetProfilingConfigurationRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"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"]},"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]}}}} ``` ## The UpdateDatasetTimePartitionRequestDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UpdateDatasetTimePartitionRequestDTO":{"type":"object","properties":{"partitionColumn":{"type":"string"},"sqlExpression":{"type":"string"}}}}}} ``` ## The UserContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]}}}} ``` ## The UserGroupContentBasicDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UserGroupContentBasicDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"}},"required":["label","name","userGroupId"]}}}} ``` ## The UserGroupContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UserGroupContentDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name of the user group. Equals `name` unless the user group has been given a label."},"name":{"type":"string"},"userGroupId":{"type":"string"},"users":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/UserContentDTO"}}},"required":["label","name","userGroupId","users"]},"UserContentDTO":{"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","userId"]}}}} ``` ## The UserListItemDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"UserListItemDTO":{"type":"object","properties":{"email":{"type":"string"},"enabled":{"type":"boolean"},"firstName":{"type":"string"},"fullName":{"type":"string"},"lastName":{"type":"string"},"userId":{"type":"string"}},"required":["email","enabled","userId"]}}}} ``` ## The ValidRangeDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ValidRangeDTO":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"}}}}}} ``` ## The ValueCountContentDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ValueCountContentDTO":{"type":"object","properties":{"count":{"type":"integer","format":"int64"},"value":{"type":"object","$ref":"#/components/schemas/_object"}}},"_object":{"type":"object"}}}} ``` ## The ZonedCronDTO object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"ZonedCronDTO":{"type":"object","properties":{"cronExpression":{"type":"string"},"timezone":{"type":"string"}},"required":["cronExpression","timezone"]}}}} ``` ## The \_object object ```json {"openapi":"3.1.0","info":{"title":"Soda Cloud API v4","version":"v1"},"components":{"schemas":{"_object":{"type":"object"}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.soda.io/apis/rest-api/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.