Quality

Check results [Paginated]

post

/quality/check_results

This endpoint provides a list of checks along with each checks's historical evaluation results.

Usage

Use this endpoint to build reports that show the outcome of your checks over time. If you gathered high-level data from the /dataset_health and /dataset_coverage endpoints, you can use this endpoint to examine more granular data about checks that apply to each dataset.

You can provide multiple dataset_ids per request, and use the from_datetime parameter to optimize performance. Use the datasets endpoint to first get a list of available datasets along with their IDs, then issue separate queries one dataset at a time.

Keep the number of potentially parallel queries that you make to this endpoint small as they can face rate limitations or poor performance.

Returns

An object of type CheckResultsResult containing an array of CheckResultsData

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations

AuthorizationstringRequired

Body

Test results request JSON Body.

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 1000Optional

Page size

Default: 400

dataset_idsstring[]Optional

Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter.

check_idsstring[]Optional

Check IDs (UUIDs from the Soda Cloud platform) to use as filter.

from_datetimestring · date-timeOptional

ISO 8601 datetime to specify the point in time from which you would like to get health historical data.

Responses

200

Successful Response

application/json

Array of CheckResultsData.

or

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post/quality/check_results

POST /v1/quality/check_results HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ],
  "check_ids": [
    "text"
  ],
  "from_datetime": "2026-01-01T00:00:00.000Z"
}

{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "result_id": "text",
      "scan_time": "2026-01-01T00:00:00.000Z",
      "level": "text",
      "check_id": "text",
      "check_name": "text",
      "created_at": "2026-01-01T00:00:00.000Z",
      "dataset_id": "text",
      "organization_id": "text",
      "metric_value": 1,
      "owner_id": "text",
      "owner_first_name": "text",
      "owner_last_name": "text",
      "owner_email": "text",
      "owner_job_title": "text",
      "owner_phone_number": "text",
      "owner_user_type": "text",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      }
    }
  ]
}

Dataset health [Paginated]

post

/quality/dataset_health

This endpoint provides you with a daily measure of the health of each of your datasets. Soda calculates a dataset's health based on the number of checks that pass during a scan. In calculating health, this endpoint returns an aggregation of the pass results from multiple scans on the same day.

Usage

Use this endpoint to get review the health of your datasets, and to see a high-level view of the more granular information that the /check_results endpoint provides.

Use this endpoint in conjunction with the /datasets endpoint as the latter adds information about each dataset.

Multiple dataset_ids are allowed per request, and use the from_datetime parameter to optimize performance.

Use the datasets endpoint to first get a list of available datasets along with their IDs, then issue separate queries one dataset at a time.

Keep the number of potentially parallel queries that you make to this endpoint small as they can face rate limitations or poor performance.

Returns

An object of type DatasetHealthResult containing an array of DatasetHealthData

Find details about the response objects in the Schemas section or by unfurling the response details.

Authorizations

AuthorizationstringRequired

Body

Dataset health request JSON Body.

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 1000Optional

Page size

Default: 400

dataset_idsstring[]Optional

Dataset IDs (UUIDs from the Soda Cloud platform) to use as filter.

from_datetimestring · date-timeOptional

ISO 8601 datetime to specify the point in time from which you would like to get health historical data.

Responses

200

Successful Response

application/json

Array of DatasetHealthData.

or

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post/quality/dataset_health

POST /v1/quality/dataset_health HTTP/1.1
Host: reporting.cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ],
  "from_datetime": "2026-01-01T00:00:00.000Z"
}

{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "organization_id": "text",
      "dataset_id": "text",
      "scan_date": "2026-01-01T00:00:00.000Z",
      "critical": 1,
      "info": 1,
      "warning": 1,
      "number_of_checks": 1,
      "percentage_passing_checks": 1,
      "last_point_percent_change": 1,
      "percent_change_percentage_passing_checks": 1,
      "number_of_distinct_checks": 1,
      "percentage_passing_distinct_passing_checks": 1,
      "last_point_distinct_checks_percent_change": 1,
      "percent_change_percentage_distinct_passing_checks": 1
    }
  ]
}