Checks

Soda Cloud API Check Endpoints

Check information

get

This endpoint enables you to gather information about the checks that in exist in your organization's Soda Cloud account, including information about the datasets and agreements with which they are associated and the incidents to which they are linked. .

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 1000, inclusive. The default value is 10.

• page: Supply an integer value. The default value is 0.

• datasetId: Optionally, use this parameter to collect only the information for checks associated with a specific dataset. Find the datasetId in the URL of the dataset page in Soda Cloud.

• checkIds: Optionally, use this parameter to collect only the information for a specific batch of checks. Provide multiple values as a comma-separated list of check IDs, which you can find on the individual check pages in Soda Cloud. This query parameter is limited to 1000 check IDs and it can't be combined with other query parameters like page, datasetId, size.

If not specified, the query gathers information for all checks in the account and sorts the results by check name in ascending order.

Authorization

Soda only returns the checks linked to datasets to which the user has View dataset permissions. Soda Cloud Admins have access to all checks.See Manage dataset roles for more information.

Authentication

User authentication required: true

This endpoint enforces authentication using the API keys you provide in the Basic authentication header.

Tags

Checks

Rate limiting

60 requests/60 seconds

Authorizations

Query parameters

checkIdsstringOptional

datasetIdstringOptional

pageinteger · int32Optional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/checks HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "attributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "checkType": "text",
      "cloudUrl": "text",
      "column": "text",
      "createdAt": "text",
      "datasets": [
        {
          "cloudUrl": "text",
          "id": "text",
          "name": "text",
          "qualifiedName": "text"
        }
      ],
      "definition": "text",
      "description": "text",
      "evaluationStatus": "pass",
      "group": {
        "groupType": "text",
        "identity": "text",
        "name": "text"
      },
      "id": "text",
      "incidents": [
        {
          "cloudUrl": "text",
          "id": "text",
          "name": "text",
          "number": 1,
          "status": "reported"
        }
      ],
      "lastCheckResultValue": {
        "dataTimestamp": "text",
        "diagnostics": {
          "aggregate": {
            "datasetRowsTested": 1
          },
          "duplicate": {
            "checkRowsTested": 1,
            "datasetRowsTested": 1,
            "failedRowsCount": 1,
            "failedRowsDataQuery": "text",
            "failedRowsKeysQuery": "text",
            "failedRowsPercent": 1,
            "failedRowsSourceQuery": "text"
          },
          "failed_rows": {
            "datasetRowsTested": 1,
            "failedRowsCount": 1,
            "failedRowsDataQuery": "text",
            "failedRowsKeysQuery": "text",
            "failedRowsPercent": 1,
            "failedRowsSourceQuery": "text"
          },
          "freshness": {
            "actualTimestamp": "text",
            "actualTimestampUtc": "text",
            "datasetRowsTested": 1,
            "expectedTimestamp": "text",
            "expectedTimestampUtc": "text"
          },
          "invalid": {
            "checkRowsTested": 1,
            "datasetRowsTested": 1,
            "failedRowsCount": 1,
            "failedRowsDataQuery": "text",
            "failedRowsKeysQuery": "text",
            "failedRowsPercent": 1,
            "failedRowsSourceQuery": "text"
          },
          "metric": {
            "datasetRowsTested": 1
          },
          "missing": {
            "checkRowsTested": 1,
            "datasetRowsTested": 1,
            "failedRowsCount": 1,
            "failedRowsDataQuery": "text",
            "failedRowsKeysQuery": "text",
            "failedRowsPercent": 1,
            "failedRowsSourceQuery": "text"
          },
          "row_count": {
            "checkRowsTested": 1,
            "datasetRowsTested": 1
          },
          "schema": {
            "actual": [
              {
                "name": "text",
                "type": "text"
              }
            ],
            "expected": [
              {
                "name": "text",
                "type": "text"
              }
            ]
          }
        },
        "id": "text",
        "measure": "time",
        "value": 1,
        "valueLabel": "text",
        "valueSeries": {
          "values": [
            {
              "label": "text",
              "level": "pass",
              "value": 1
            }
          ]
        }
      },
      "name": "text"
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}