# Models

## The AuditTrailData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"AuditTrailData":{"title":"AuditTrailData","type":"object","properties":{"correlation_id":{"title":"Correlation Id","type":"string","description":"Identifier of a given audited request. Note this column cannot be used as a primary key as it can span over multiple rows."},"eventTime":{"title":"Eventtime","type":"string","description":"ISO UTC datetime at which the event happened.","format":"date-time"},"ipAddress":{"title":"Ipaddress","type":"string","description":"IP address of the user who performed the logged action."},"email":{"title":"Email","type":"string","description":"Email address of the user who performed the logged action."},"apiKey":{"title":"Apikey","type":"string","description":"Obfuscated API key of the user who performed the logged action."},"comment":{"title":"Comment","type":"string","description":"Explanation of the audited event."},"hash":{"title":"Hash","type":"string","description":"A tamper-proof security and verification hash."}},"description":"Contains audited events from the authorized user's organization."}}}}
```

## The AuditTrailResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"AuditTrailResult":{"title":"AuditTrailResult","required":["data"],"type":"object","properties":{"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/AuditTrailData"}},"resource":{"title":"Resource","type":"string","default":"audit_trail"}},"description":"Array of `AuditTrailData`."},"AuditTrailData":{"title":"AuditTrailData","type":"object","properties":{"correlation_id":{"title":"Correlation Id","type":"string","description":"Identifier of a given audited request. Note this column cannot be used as a primary key as it can span over multiple rows."},"eventTime":{"title":"Eventtime","type":"string","description":"ISO UTC datetime at which the event happened.","format":"date-time"},"ipAddress":{"title":"Ipaddress","type":"string","description":"IP address of the user who performed the logged action."},"email":{"title":"Email","type":"string","description":"Email address of the user who performed the logged action."},"apiKey":{"title":"Apikey","type":"string","description":"Obfuscated API key of the user who performed the logged action."},"comment":{"title":"Comment","type":"string","description":"Explanation of the audited event."},"hash":{"title":"Hash","type":"string","description":"A tamper-proof security and verification hash."}},"description":"Contains audited events from the authorized user's organization."}}}}
```

## The CheckRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"CheckRequest":{"title":"CheckRequest","type":"object","properties":{"page":{"title":"Page","minimum":1,"type":"integer","description":"Page number","default":1},"size":{"title":"Size","maximum":1000,"minimum":1,"type":"integer","description":"Page size","default":400},"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."},"check_ids":{"title":"Check Ids","type":"array","items":{"type":"string"},"description":"Check IDs (UUIDs from the Soda Cloud platform) to use as filter."}},"description":"Tests request JSON Body."}}}}
```

## The CheckResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"CheckResult":{"title":"CheckResult","required":["total","page","size","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/ChecksData"}}},"description":"Array of `TestsData`."},"ChecksData":{"title":"ChecksData","type":"object","properties":{"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"check_type":{"title":"Check Type","type":"string","description":"\nType of Soda check. For example, the type is \"metric\" if the check uses a metric in Soda Cloud;\n\"external\" if the check is evaluated by Soda SQL.\n        "},"created_at":{"title":"Created At","type":"string","description":"UTC timestamp at which the check was created.","format":"date-time"},"is_archived":{"title":"Is Archived","type":"string","description":"Whether the check is archived."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a check"},"check_group_aggregate_id":{"title":"Check Group Aggregate Id","type":"string","description":"\nIn the UI, group checks are displayed as a single expandable check or group.\nWhen not null, this field holds the ID of the group, allowing sub-checks to be paired\nusing the check_group_aggregate_id. Checks with a check_group_id are termed \"aggregate checks\".\nThey lack associated results and don't count for coverage, but their sub-checks do.\n    "},"check_group_id":{"title":"Check Group Id","type":"string","description":"\nUse this field to group sub-checks that are part of a group check type.\n"},"is_group_aggregate_check":{"title":"Is Group Aggregate Check","type":"boolean","description":"\nIn the UI, group checks are displayed as a single expendable check or group.\nWhen true, this field allows you to filter or know that this record of a check corresponds\nto the group check (the \"aggregate if you will). This check does not have check results associated.\n"},"source":{"title":"Source","type":"string","description":"Specifies the check's source application or system. It is usually null, indicating the soda-library as the default. Set explicitly for dbt ingested tests."}},"description":"Contains information about a check and its associated datasets."}}}}
```

## The CheckResultsData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"CheckResultsData":{"title":"CheckResultsData","type":"object","properties":{"result_id":{"title":"Result Id","type":"string","description":"Identifier (UUID) of a test result in Soda Cloud."},"scan_time":{"title":"Scan Time","type":"string","description":"UTC timestamp of the scan that generated a specific test result.","format":"date-time"},"level":{"title":"Level","type":"string","description":"Severity level of a check result. Levels are: 'info', 'warning', and 'critical'."},"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"created_at":{"title":"Created At","type":"string","description":"UTC timestamp at which the check was created.","format":"date-time"},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"metric_value":{"title":"Metric Value","type":"number","description":"Value of a Soda metric"},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a check"}},"description":"Contains information about checks and their results on a per scan basis."}}}}
```

## The CheckResultsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"CheckResultsRequest":{"title":"CheckResultsRequest","type":"object","properties":{"page":{"title":"Page","minimum":1,"type":"integer","description":"Page number","default":1},"size":{"title":"Size","maximum":1000,"minimum":1,"type":"integer","description":"Page size","default":400},"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."},"check_ids":{"title":"Check Ids","type":"array","items":{"type":"string"},"description":"Check IDs (UUIDs from the Soda Cloud platform) to use as filter."},"from_datetime":{"title":"From Datetime","type":"string","description":"\nISO 8601 datetime to specify the point in time from which you would like to get health historical data.\n","format":"date-time"}},"description":"Test results request JSON Body."}}}}
```

## The CheckResultsResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"CheckResultsResult":{"title":"CheckResultsResult","required":["total","page","size","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/CheckResultsData"}}},"description":"Array of `CheckResultsData`."},"CheckResultsData":{"title":"CheckResultsData","type":"object","properties":{"result_id":{"title":"Result Id","type":"string","description":"Identifier (UUID) of a test result in Soda Cloud."},"scan_time":{"title":"Scan Time","type":"string","description":"UTC timestamp of the scan that generated a specific test result.","format":"date-time"},"level":{"title":"Level","type":"string","description":"Severity level of a check result. Levels are: 'info', 'warning', and 'critical'."},"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"created_at":{"title":"Created At","type":"string","description":"UTC timestamp at which the check was created.","format":"date-time"},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"metric_value":{"title":"Metric Value","type":"number","description":"Value of a Soda metric"},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a check"}},"description":"Contains information about checks and their results on a per scan basis."}}}}
```

## The ChecksData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"ChecksData":{"title":"ChecksData","type":"object","properties":{"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"check_type":{"title":"Check Type","type":"string","description":"\nType of Soda check. For example, the type is \"metric\" if the check uses a metric in Soda Cloud;\n\"external\" if the check is evaluated by Soda SQL.\n        "},"created_at":{"title":"Created At","type":"string","description":"UTC timestamp at which the check was created.","format":"date-time"},"is_archived":{"title":"Is Archived","type":"string","description":"Whether the check is archived."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a check"},"check_group_aggregate_id":{"title":"Check Group Aggregate Id","type":"string","description":"\nIn the UI, group checks are displayed as a single expandable check or group.\nWhen not null, this field holds the ID of the group, allowing sub-checks to be paired\nusing the check_group_aggregate_id. Checks with a check_group_id are termed \"aggregate checks\".\nThey lack associated results and don't count for coverage, but their sub-checks do.\n    "},"check_group_id":{"title":"Check Group Id","type":"string","description":"\nUse this field to group sub-checks that are part of a group check type.\n"},"is_group_aggregate_check":{"title":"Is Group Aggregate Check","type":"boolean","description":"\nIn the UI, group checks are displayed as a single expendable check or group.\nWhen true, this field allows you to filter or know that this record of a check corresponds\nto the group check (the \"aggregate if you will). This check does not have check results associated.\n"},"source":{"title":"Source","type":"string","description":"Specifies the check's source application or system. It is usually null, indicating the soda-library as the default. Set explicitly for dbt ingested tests."}},"description":"Contains information about a check and its associated datasets."}}}}
```

## The DatasetCoverageDataObject object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetCoverageDataObject":{"title":"DatasetCoverageDataObject","required":["descriptives","dataset_info"],"type":"object","properties":{"descriptives":{"$ref":"#/components/schemas/DatasetCoverageDescriptivesData"},"dataset_info":{"title":"Dataset Info","type":"array","items":{"$ref":"#/components/schemas/DatasetInfoData"}}},"description":"Array of `DatasetInfoData` and `DatasetCoverageDescriptivesData`."},"DatasetCoverageDescriptivesData":{"title":"DatasetCoverageDescriptivesData","type":"object","properties":{"median_number_of_checks":{"title":"Median Number Of Checks","type":"number","description":"Median number of checks across all datasets in your organization.","default":0},"max_number_of_checks":{"title":"Max Number Of Checks","type":"number","description":"Maximum number of checks across all datasets in your organization.","default":0},"min_number_of_checks":{"title":"Min Number Of Checks","type":"number","description":"Minimum number of checks across all datasets in your organization.","default":0},"standard_deviation_number_of_checks":{"title":"Standard Deviation Number Of Checks","anyOf":[{"type":"number"},{"type":"string"},{"type":"integer"}],"description":"Standard deviation of the number of checks across all datasets in your organization.","default":0},"mean_number_of_checks":{"title":"Mean Number Of Checks","type":"number","description":"Mean number of checks across all datasets in your organization.","default":0}},"description":"Contains coverage descriptives across datasets."},"DatasetInfoData":{"title":"DatasetInfoData","type":"object","properties":{"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"number_of_checks":{"title":"Number Of Checks","type":"integer","description":"Number of checks covering a specific dataset."},"relative_coverage_score":{"title":"Relative Coverage Score","type":"string","description":"\nA score derived by comparing the number of checks that apply to a single dataset to the number of checks\nthat apply to other datasets in your organization's Soda Cloud account. Soda applies the labels \"good\", \"medium\", and\n\"poor\" based on a 3-ntile split.\n        "}},"description":"Information about a dataset including whether a dataset is active or deleted,\nand check coverage metrics."}}}}
```

## The DatasetCoverageDescriptivesData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetCoverageDescriptivesData":{"title":"DatasetCoverageDescriptivesData","type":"object","properties":{"median_number_of_checks":{"title":"Median Number Of Checks","type":"number","description":"Median number of checks across all datasets in your organization.","default":0},"max_number_of_checks":{"title":"Max Number Of Checks","type":"number","description":"Maximum number of checks across all datasets in your organization.","default":0},"min_number_of_checks":{"title":"Min Number Of Checks","type":"number","description":"Minimum number of checks across all datasets in your organization.","default":0},"standard_deviation_number_of_checks":{"title":"Standard Deviation Number Of Checks","anyOf":[{"type":"number"},{"type":"string"},{"type":"integer"}],"description":"Standard deviation of the number of checks across all datasets in your organization.","default":0},"mean_number_of_checks":{"title":"Mean Number Of Checks","type":"number","description":"Mean number of checks across all datasets in your organization.","default":0}},"description":"Contains coverage descriptives across datasets."}}}}
```

## The DatasetCoverageRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetCoverageRequest":{"title":"DatasetCoverageRequest","type":"object","properties":{"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."}},"description":"Dataset coverage request JSON Body."}}}}
```

## The DatasetCoverageResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetCoverageResult":{"title":"DatasetCoverageResult","required":["data"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/DatasetCoverageDataObject"}},"description":"Array of `DatasetInfoData` and `DatasetCoverageDescriptivesData`."},"DatasetCoverageDataObject":{"title":"DatasetCoverageDataObject","required":["descriptives","dataset_info"],"type":"object","properties":{"descriptives":{"$ref":"#/components/schemas/DatasetCoverageDescriptivesData"},"dataset_info":{"title":"Dataset Info","type":"array","items":{"$ref":"#/components/schemas/DatasetInfoData"}}},"description":"Array of `DatasetInfoData` and `DatasetCoverageDescriptivesData`."},"DatasetCoverageDescriptivesData":{"title":"DatasetCoverageDescriptivesData","type":"object","properties":{"median_number_of_checks":{"title":"Median Number Of Checks","type":"number","description":"Median number of checks across all datasets in your organization.","default":0},"max_number_of_checks":{"title":"Max Number Of Checks","type":"number","description":"Maximum number of checks across all datasets in your organization.","default":0},"min_number_of_checks":{"title":"Min Number Of Checks","type":"number","description":"Minimum number of checks across all datasets in your organization.","default":0},"standard_deviation_number_of_checks":{"title":"Standard Deviation Number Of Checks","anyOf":[{"type":"number"},{"type":"string"},{"type":"integer"}],"description":"Standard deviation of the number of checks across all datasets in your organization.","default":0},"mean_number_of_checks":{"title":"Mean Number Of Checks","type":"number","description":"Mean number of checks across all datasets in your organization.","default":0}},"description":"Contains coverage descriptives across datasets."},"DatasetInfoData":{"title":"DatasetInfoData","type":"object","properties":{"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"number_of_checks":{"title":"Number Of Checks","type":"integer","description":"Number of checks covering a specific dataset."},"relative_coverage_score":{"title":"Relative Coverage Score","type":"string","description":"\nA score derived by comparing the number of checks that apply to a single dataset to the number of checks\nthat apply to other datasets in your organization's Soda Cloud account. Soda applies the labels \"good\", \"medium\", and\n\"poor\" based on a 3-ntile split.\n        "}},"description":"Information about a dataset including whether a dataset is active or deleted,\nand check coverage metrics."}}}}
```

## The DatasetHealthData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetHealthData":{"title":"DatasetHealthData","type":"object","properties":{"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"scan_date":{"title":"Scan Date","type":"string","description":"Date at which any number of scans were run.","format":"date-time"},"critical":{"title":"Critical","type":"integer","description":"Number of checks and monitors that failed with a Critical level alert."},"info":{"title":"Info","type":"integer","description":"Number of checks and monitors that passed."},"warning":{"title":"Warning","type":"integer","description":"Number of checks and monitors that failed with a Warning level alert."},"number_of_checks":{"title":"Number Of Checks","type":"integer","description":"Number of checks and monitors executed."},"percentage_passing_checks":{"title":"Percentage Passing Checks","type":"number","description":"Proportion of checks and monitors that passed."},"last_point_percent_change":{"title":"Last Point Percent Change","type":"number","description":"Percentage change from last point."},"percent_change_percentage_passing_checks":{"title":"Percent Change Percentage Passing Checks","type":"number","description":"\n        Percentage change of the last data health point compared to a rolling average over the last\n        3\n        "},"number_of_distinct_checks":{"title":"Number Of Distinct Checks","type":"integer","description":"Number of distinct checks and monitors executed."},"percentage_passing_distinct_passing_checks":{"title":"Percentage Passing Distinct Passing Checks","type":"number","description":"\n            This calculation divides the number of checks that passed by\n            the total number of checks evaluated. Soda aggregates the\n            score daily and, in the calculation, uses the results from the\n            latest check evaluations on that day.\n            "},"last_point_distinct_checks_percent_change":{"title":"Last Point Distinct Checks Percent Change","type":"number","description":"Percentage change from last previous result of percent_change_percentage_distinct_passing_checks"},"percent_change_percentage_distinct_passing_checks":{"title":"Percent Change Percentage Distinct Passing Checks","type":"number","description":"\n        Percentage change from the last percent_change_percentage_distinct_passing point compared to\n        a rolling average over the last\n        3\n        "}},"description":"Dataset health information containing counts of passing or failing checks (warning or critical) per scan date."}}}}
```

## The DatasetHealthRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetHealthRequest":{"title":"DatasetHealthRequest","type":"object","properties":{"page":{"title":"Page","minimum":1,"type":"integer","description":"Page number","default":1},"size":{"title":"Size","maximum":1000,"minimum":1,"type":"integer","description":"Page size","default":400},"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."},"from_datetime":{"title":"From Datetime","type":"string","description":"\nISO 8601 datetime to specify the point in time from which you would like to get health historical data.\n","format":"date-time"}},"description":"Dataset health request JSON Body."}}}}
```

## The DatasetHealthResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetHealthResult":{"title":"DatasetHealthResult","required":["total","page","size","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/DatasetHealthData"}}},"description":"Array of `DatasetHealthData`."},"DatasetHealthData":{"title":"DatasetHealthData","type":"object","properties":{"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"scan_date":{"title":"Scan Date","type":"string","description":"Date at which any number of scans were run.","format":"date-time"},"critical":{"title":"Critical","type":"integer","description":"Number of checks and monitors that failed with a Critical level alert."},"info":{"title":"Info","type":"integer","description":"Number of checks and monitors that passed."},"warning":{"title":"Warning","type":"integer","description":"Number of checks and monitors that failed with a Warning level alert."},"number_of_checks":{"title":"Number Of Checks","type":"integer","description":"Number of checks and monitors executed."},"percentage_passing_checks":{"title":"Percentage Passing Checks","type":"number","description":"Proportion of checks and monitors that passed."},"last_point_percent_change":{"title":"Last Point Percent Change","type":"number","description":"Percentage change from last point."},"percent_change_percentage_passing_checks":{"title":"Percent Change Percentage Passing Checks","type":"number","description":"\n        Percentage change of the last data health point compared to a rolling average over the last\n        3\n        "},"number_of_distinct_checks":{"title":"Number Of Distinct Checks","type":"integer","description":"Number of distinct checks and monitors executed."},"percentage_passing_distinct_passing_checks":{"title":"Percentage Passing Distinct Passing Checks","type":"number","description":"\n            This calculation divides the number of checks that passed by\n            the total number of checks evaluated. Soda aggregates the\n            score daily and, in the calculation, uses the results from the\n            latest check evaluations on that day.\n            "},"last_point_distinct_checks_percent_change":{"title":"Last Point Distinct Checks Percent Change","type":"number","description":"Percentage change from last previous result of percent_change_percentage_distinct_passing_checks"},"percent_change_percentage_distinct_passing_checks":{"title":"Percent Change Percentage Distinct Passing Checks","type":"number","description":"\n        Percentage change from the last percent_change_percentage_distinct_passing point compared to\n        a rolling average over the last\n        3\n        "}},"description":"Dataset health information containing counts of passing or failing checks (warning or critical) per scan date."}}}}
```

## The DatasetInfoData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetInfoData":{"title":"DatasetInfoData","type":"object","properties":{"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"number_of_checks":{"title":"Number Of Checks","type":"integer","description":"Number of checks covering a specific dataset."},"relative_coverage_score":{"title":"Relative Coverage Score","type":"string","description":"\nA score derived by comparing the number of checks that apply to a single dataset to the number of checks\nthat apply to other datasets in your organization's Soda Cloud account. Soda applies the labels \"good\", \"medium\", and\n\"poor\" based on a 3-ntile split.\n        "}},"description":"Information about a dataset including whether a dataset is active or deleted,\nand check coverage metrics."}}}}
```

## The DatasetsData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetsData":{"title":"DatasetsData","type":"object","properties":{"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"dataset_name":{"title":"Dataset Name","type":"string","description":"Name of the dataset in Soda Cloud corresponding to the name of the dataset in the data source."},"dataset_label":{"title":"Dataset Label","type":"string","description":"Custom name given to a dataset in Soda Cloud. Will often be identical to dataset_name"},"tags":{"title":"Tags","type":"array","items":{"type":"string"},"description":"User-provided list of tags."},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"owner_last_login_at":{"title":"Owner Last Login At","type":"string","description":"Timestamp corresponding to the last time the owner logged into Soda Cloud.","format":"date-time"},"number_of_rows":{"title":"Number Of Rows","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Current (and latest known) number of rows in the dataset."},"number_of_failed_checks":{"title":"Number Of Failed Checks","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Number of checks that failed on a specific dataset."},"last_scan_time":{"title":"Last Scan Time","type":"string","description":"UTC timestamp of the last scan run on a dataset.","format":"date-time"},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a dataset"},"datasource_id":{"title":"Datasource Id","type":"string","description":"UUID of the data source as assigned by the Soda Cloud platform."},"datasource_name":{"title":"Datasource Name","type":"string","description":"\nName of the datasource in Soda Cloud coresponding to the name of the\n datasource in your configuration file."},"datasource_label":{"title":"Datasource Label","type":"string","description":"Label of the datasource corresponding to the name displayed in Soda Cloud"},"datasource_source_owner":{"title":"Datasource Source Owner","type":"string","description":"The name of the source application (e.g. soda-core) that owns the data source."},"datasource_owner_id":{"title":"Datasource Owner Id","type":"string","description":"UUID corresponding the the configured datasource owner."},"datasource_has_core_agent_enabled":{"title":"Datasource Has Core Agent Enabled","type":"boolean","description":"Boolean indicating whether the datasource is onboarded and part of a Soda Agent."}},"description":"Contains information about a dataset."}}}}
```

## The DatasetsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetsRequest":{"title":"DatasetsRequest","type":"object","properties":{"page":{"title":"Page","minimum":1,"type":"integer","description":"Page number","default":1},"size":{"title":"Size","maximum":1000,"minimum":1,"type":"integer","description":"Page size","default":400},"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."}},"description":"Datasets request JSON Body."}}}}
```

## The DatasetsResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"DatasetsResult":{"title":"DatasetsResult","required":["total","page","size","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/DatasetsData"}}},"description":"Array of `DatasetsData`."},"DatasetsData":{"title":"DatasetsData","type":"object","properties":{"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"dataset_name":{"title":"Dataset Name","type":"string","description":"Name of the dataset in Soda Cloud corresponding to the name of the dataset in the data source."},"dataset_label":{"title":"Dataset Label","type":"string","description":"Custom name given to a dataset in Soda Cloud. Will often be identical to dataset_name"},"tags":{"title":"Tags","type":"array","items":{"type":"string"},"description":"User-provided list of tags."},"owner_id":{"title":"Owner Id","type":"string","description":"Identifier (UUID) of the check owner in Soda Cloud."},"owner_first_name":{"title":"Owner First Name","type":"string","description":"First name of the check owner."},"owner_last_name":{"title":"Owner Last Name","type":"string","description":"Last name of the check owner."},"owner_email":{"title":"Owner Email","type":"string","description":"Email of the check owner."},"owner_job_title":{"title":"Owner Job Title","type":"string","description":"Job title of the check owner."},"owner_phone_number":{"title":"Owner Phone Number","type":"string","description":"Phone number of the check owner."},"owner_user_type":{"title":"Owner User Type","type":"string","description":"User type of the check owner."},"owner_last_login_at":{"title":"Owner Last Login At","type":"string","description":"Timestamp corresponding to the last time the owner logged into Soda Cloud.","format":"date-time"},"number_of_rows":{"title":"Number Of Rows","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Current (and latest known) number of rows in the dataset."},"number_of_failed_checks":{"title":"Number Of Failed Checks","anyOf":[{"type":"integer"},{"type":"string"}],"description":"Number of checks that failed on a specific dataset."},"last_scan_time":{"title":"Last Scan Time","type":"string","description":"UTC timestamp of the last scan run on a dataset.","format":"date-time"},"attributes":{"title":"Attributes","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Atributes of a dataset"},"datasource_id":{"title":"Datasource Id","type":"string","description":"UUID of the data source as assigned by the Soda Cloud platform."},"datasource_name":{"title":"Datasource Name","type":"string","description":"\nName of the datasource in Soda Cloud coresponding to the name of the\n datasource in your configuration file."},"datasource_label":{"title":"Datasource Label","type":"string","description":"Label of the datasource corresponding to the name displayed in Soda Cloud"},"datasource_source_owner":{"title":"Datasource Source Owner","type":"string","description":"The name of the source application (e.g. soda-core) that owns the data source."},"datasource_owner_id":{"title":"Datasource Owner Id","type":"string","description":"UUID corresponding the the configured datasource owner."},"datasource_has_core_agent_enabled":{"title":"Datasource Has Core Agent Enabled","type":"boolean","description":"Boolean indicating whether the datasource is onboarded and part of a Soda Agent."}},"description":"Contains information about a dataset."}}}}
```

## The GetTokenResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"GetTokenResult":{"title":"GetTokenResult","type":"object","properties":{"user":{"title":"User","type":"string","description":"User's username (email addess used at sign up)."},"token":{"title":"Token","type":"string","description":"\n            API Token to use for authentication. This token expires. Its expiration is also provided in the response.\n            "},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"expires_in":{"title":"Expires In","type":"integer","description":"Token's expiration time in seconds."}},"description":"Soda Cloud API token and organisation ID information to use in this API's endpoints."}}}}
```

## The HTTPValidationError object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}}
```

## The IncidentData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"IncidentData":{"title":"IncidentData","type":"object","properties":{"incident_id_report_date_id":{"title":"Incident Id Report Date Id","type":"string","description":"Incident report date Id (UUID) that uniquely identifies an incident and a report_date as shown in the Soda Cloud Incidents page."},"incident_id":{"title":"Incident Id","type":"string","description":"Incident ID (UUID) of the incident in the Soda Cloud Incidents page."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"created_at":{"title":"Created At","type":"string","description":"ISO timestamp of the date at which the incidents was created in the Soda Cloud Dataset page.","format":"date-time"},"last_updated":{"title":"Last Updated","type":"string","description":"ISO timestamp of the date at which the incident was last updated.","format":"date-time"},"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"check_result_id":{"title":"Check Result Id","type":"string","description":"Check result Id (UUID) of check result to which incident corresponds."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"title":{"title":"Title","type":"string","description":"Title of the incident as shown in the Soda Cloud Incidents page."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"severity":{"title":"Severity","type":"string","description":"Severity of the incident as shown in the Soda Cloud Incidents page."},"description_notes":{"title":"Description Notes","type":"string","description":"Description notes of the incident as shown in the incident overview."},"resolution_notes":{"title":"Resolution Notes","type":"string","description":"Resolution notes of the incident as shown in the incident overview."},"lead_id":{"title":"Lead Id","type":"string","description":"Lead ID (UUID) of the lead assigned to the incident in the Soda Cloud Incidents page."},"lead_email":{"title":"Lead Email","type":"string","description":"Email of the lead assigned to the incident in the Soda Cloud Incidents page."},"reporter_id":{"title":"Reporter Id","type":"string","description":"Reporter ID (UUID) of the user that reported the incident in the Soda Cloud Incidents page."},"reporter_email":{"title":"Reporter Email","type":"string","description":"Reporter email of the user that reported the incident in the incident overview."},"report_date":{"title":"Report Date","type":"string","description":"Report date for which the incident information is shown.","format":"date"},"resolved_at":{"title":"Resolved At","type":"string","description":"ISO timestamp of the date at which incident was resolved in the Soda Cloud Incidents page.","format":"date-time"},"status":{"title":"Status","type":"string","description":"Status of the incident as shown in the Soda Cloud Incidents page."}},"description":"Contains incident information (see field documentation for explanations)"}}}}
```

## The IncidentsRequest object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"IncidentsRequest":{"title":"IncidentsRequest","type":"object","properties":{"page":{"title":"Page","minimum":1,"type":"integer","description":"Page number","default":1},"size":{"title":"Size","maximum":1000,"minimum":1,"type":"integer","description":"Page size","default":400},"dataset_ids":{"title":"Dataset Ids","type":"array","items":{"type":"string"},"description":"Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter."},"status":{"title":"Status","type":"string","description":"\nString representing the status of issues you want to retrieve. Currently you can retrieve either:\n- all 'resolved' issues or\n- all 'unresolved' issues\n","default":"unresolved"},"from_datetime":{"title":"From Datetime","type":"string","description":"ISO timestamp from which you want to retrieve incidents. Defaults to last 31 days.","format":"date-time","default":"2023-10-09T09:18:16.255021"},"to_datetime":{"title":"To Datetime","type":"string","description":"ISO timestamp up to which you want to retrieve incidents. Defaults to today.","format":"date-time","default":"2023-11-09T09:18:16.255029"}},"description":"Incidents request JSON Body."}}}}
```

## The IncidentsResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"IncidentsResult":{"title":"IncidentsResult","required":["total","page","size","data"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"},"data":{"title":"Data","type":"array","items":{"$ref":"#/components/schemas/IncidentData"}}},"description":"Array of `IncidentsData`."},"IncidentData":{"title":"IncidentData","type":"object","properties":{"incident_id_report_date_id":{"title":"Incident Id Report Date Id","type":"string","description":"Incident report date Id (UUID) that uniquely identifies an incident and a report_date as shown in the Soda Cloud Incidents page."},"incident_id":{"title":"Incident Id","type":"string","description":"Incident ID (UUID) of the incident in the Soda Cloud Incidents page."},"organization_id":{"title":"Organization Id","type":"string","description":"Identifier (UUID) of an organization in Soda Cloud."},"created_at":{"title":"Created At","type":"string","description":"ISO timestamp of the date at which the incidents was created in the Soda Cloud Dataset page.","format":"date-time"},"last_updated":{"title":"Last Updated","type":"string","description":"ISO timestamp of the date at which the incident was last updated.","format":"date-time"},"check_id":{"title":"Check Id","type":"string","description":"Identifier (UUID) of a check in Soda Cloud."},"check_result_id":{"title":"Check Result Id","type":"string","description":"Check result Id (UUID) of check result to which incident corresponds."},"dataset_id":{"title":"Dataset Id","type":"string","description":"Identifier (UUID) of a dataset in Soda Cloud."},"title":{"title":"Title","type":"string","description":"Title of the incident as shown in the Soda Cloud Incidents page."},"check_name":{"title":"Check Name","type":"string","description":"Name of a specific check in Soda Cloud."},"severity":{"title":"Severity","type":"string","description":"Severity of the incident as shown in the Soda Cloud Incidents page."},"description_notes":{"title":"Description Notes","type":"string","description":"Description notes of the incident as shown in the incident overview."},"resolution_notes":{"title":"Resolution Notes","type":"string","description":"Resolution notes of the incident as shown in the incident overview."},"lead_id":{"title":"Lead Id","type":"string","description":"Lead ID (UUID) of the lead assigned to the incident in the Soda Cloud Incidents page."},"lead_email":{"title":"Lead Email","type":"string","description":"Email of the lead assigned to the incident in the Soda Cloud Incidents page."},"reporter_id":{"title":"Reporter Id","type":"string","description":"Reporter ID (UUID) of the user that reported the incident in the Soda Cloud Incidents page."},"reporter_email":{"title":"Reporter Email","type":"string","description":"Reporter email of the user that reported the incident in the incident overview."},"report_date":{"title":"Report Date","type":"string","description":"Report date for which the incident information is shown.","format":"date"},"resolved_at":{"title":"Resolved At","type":"string","description":"ISO timestamp of the date at which incident was resolved in the Soda Cloud Incidents page.","format":"date-time"},"status":{"title":"Status","type":"string","description":"Status of the incident as shown in the Soda Cloud Incidents page."}},"description":"Contains incident information (see field documentation for explanations)"}}}}
```

## The LastETLRefreshResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"LastETLRefreshResult":{"title":"LastETLRefreshResult","type":"object","properties":{"resource":{"title":"Resource","type":"string","default":"last_etl_refresh"},"data":{"title":"Data","allOf":[{"$ref":"#/components/schemas/LastETLRefreshResultData"}],"description":"Contains ETL last refreshed timestamp"}},"description":"Result of request to the last ETL refreshed endpoint."},"LastETLRefreshResultData":{"title":"LastETLRefreshResultData","type":"object","properties":{"last_etl_refresh_at":{"title":"Last Etl Refresh At","type":"string","description":"ISO timestamp of the date at which ETL was last refreshed.","format":"date-time"}},"description":"Contains ETL last refreshed timestamp"}}}}
```

## The LastETLRefreshResultData object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"LastETLRefreshResultData":{"title":"LastETLRefreshResultData","type":"object","properties":{"last_etl_refresh_at":{"title":"Last Etl Refresh At","type":"string","description":"ISO timestamp of the date at which ETL was last refreshed.","format":"date-time"}},"description":"Contains ETL last refreshed timestamp"}}}}
```

## The NoContentError object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"NoContentError":{"title":"NoContentError","type":"object","properties":{"resource":{"title":"Resource","type":"string","description":"Name of the resource. Usually the same string as the endpoint."},"data":{"title":"Data","type":"array","items":{"type":"object"},"description":"Generic data payload from the query. Should be overidden with a more specific pydandic model.","default":[]},"detail":{"title":"Detail","type":"string","default":"No results for the requested data. Since the data is pre-processed in batches it might be that the data you are looking for has not yet been processed. You can check when the last refresh took place by using the /last_etl_refresh_info endpoint. If you think this is a bug and you should be getting results, get in touch with us."}},"description":"Response Schema of a NoContent Error"}}}}
```

## The PaginatedResult object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"PaginatedResult":{"title":"PaginatedResult","required":["total","page","size"],"type":"object","properties":{"total":{"title":"Total","type":"integer"},"page":{"title":"Page","type":"integer"},"size":{"title":"Size","type":"integer"}},"description":"Pydantic model for a basic paginated result with pagination info."}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.2","info":{"title":"Soda Cloud Reporting API","version":"1.3.1"},"components":{"schemas":{"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}}}}
```