Coverage

Checks [Paginated]

post

https://reporting.cloud.soda.io/v1https://reporting.cloud.us.soda.io/v1

/coverage/checks

This endpoint provides a real-time list of all the check that exist in your organization's account, as well as the datasets upon which each check depends.

Usage

Use this endpoint to enrich results from the /datasets or /check_results endpoints.

Returns

An object of type CheckResult containing an array of CheckData for each check.

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

Authorizations

HTTPBasicSodaBackendTokenAPIKeyCookieApiKeyId[Soon Deprecated] Use XApiKeyIDAPIKeySecret[Soon Deprecated] Use XApiKeySecretXApiKeyIdXApiKeySecret

AuthorizationstringRequired

Body

application/json

Responses

200

Successful Response

application/json

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post

/coverage/checks

HTTPcURLJavaScriptPython

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

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ],
  "check_ids": [
    "text"
  ]
}

{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "check_id": "text",
      "organization_id": "text",
      "check_name": "text",
      "check_type": "text",
      "created_at": "2026-01-28T19:12:14.348Z",
      "is_archived": "text",
      "dataset_id": "text",
      "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"
        ]
      },
      "check_group_aggregate_id": "text",
      "check_group_id": "text",
      "is_group_aggregate_check": true,
      "source": "text"
    }
  ]
}

Datasets [Paginated]

post

https://reporting.cloud.soda.io/v1https://reporting.cloud.us.soda.io/v1

/coverage/datasets

This endpoint provides information about all the datasets that your team has connected to your organization's Soda Cloud account.

Usage

Use this endpoint to review the number of datasets Soda Cloud accesses, including each dataset's most recent scan time and test failure counts.

Use the data from this endpoint to enrich other endpoints' data such as /dataset_health and /dataset_coverage

Returns

An object of type DatasetsResult containing an array of DatasetsData

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

Authorizations

HTTPBasicSodaBackendTokenAPIKeyCookieApiKeyId[Soon Deprecated] Use XApiKeyIDAPIKeySecret[Soon Deprecated] Use XApiKeySecretXApiKeyIdXApiKeySecret

AuthorizationstringRequired

Body

application/json

Responses

200

Successful Response

application/json

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post

/coverage/datasets

HTTPcURLJavaScriptPython

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

{
  "page": 1,
  "size": 400,
  "dataset_ids": [
    "text"
  ]
}

{
  "total": 1,
  "page": 1,
  "size": 1,
  "data": [
    {
      "dataset_id": "text",
      "organization_id": "text",
      "dataset_name": "text",
      "dataset_label": "text",
      "tags": [
        "text"
      ],
      "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",
      "owner_last_login_at": "2026-01-28T19:12:14.348Z",
      "number_of_rows": 1,
      "number_of_failed_checks": 1,
      "last_scan_time": "2026-01-28T19:12:14.348Z",
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": [
          "text"
        ]
      },
      "datasource_id": "text",
      "datasource_name": "text",
      "datasource_label": "text",
      "datasource_source_owner": "text",
      "datasource_owner_id": "text",
      "datasource_has_core_agent_enabled": true
    }
  ]
}

Dataset coverage

post

https://reporting.cloud.soda.io/v1https://reporting.cloud.us.soda.io/v1

/coverage/dataset_coverage

This endpoint provides a daily measure of the test coverage of your datasets. It derives a relative_coverage_score which compares the number of checks that apply to a single dataset to other datasets connected to your organization's Soda Cloud account. (Refer to the DatasetCoverageData schema for more information.)

Usage

Use this endpoint to review the relative test coverage of your datasets, and to see a high-level view of the more granular information that the /tests_and_results endpoint provides.

This endpoint is best used in conjunction with the /datasets endpoint as the latter augments the level of information about each dataset.

Returns

An object of type DatasetCoverageResult containing an array of DatasetCoverageData

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

Authorizations

HTTPBasicSodaBackendTokenAPIKeyCookieApiKeyId[Soon Deprecated] Use XApiKeyIDAPIKeySecret[Soon Deprecated] Use XApiKeySecretXApiKeyIdXApiKeySecret

AuthorizationstringRequired

Body

application/json

Responses

200

Successful Response

application/json

202

Successful request but no data was returned

application/json

422

Validation Error

application/json

post

/coverage/dataset_coverage

HTTPcURLJavaScriptPython

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

{
  "dataset_ids": [
    "text"
  ]
}

{
  "data": {
    "descriptives": {
      "median_number_of_checks": 0,
      "max_number_of_checks": 0,
      "min_number_of_checks": 0,
      "standard_deviation_number_of_checks": 0,
      "mean_number_of_checks": 0
    },
    "dataset_info": [
      {
        "dataset_id": "text",
        "number_of_checks": 1,
        "relative_coverage_score": "text"
      }
    ]
  }
}