POST
/
api
/
datachecks
/
testsuggestions
/
v1
curl --request POST \
  --url https://developer.synq.io/api/datachecks/testsuggestions/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "suggestions": [
    {
      "identifier": {
        "dbtCoreNode": {
          "integrationId": "<string>",
          "nodeId": "<string>"
        },
        "dbtCloudNode": {
          "projectId": "<string>",
          "accountId": "<string>",
          "nodeId": "<string>"
        },
        "bigqueryTable": {
          "project": "<string>",
          "dataset": "<string>",
          "table": "<string>"
        },
        "snowflakeTable": {
          "account": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "redshiftTable": {
          "cluster": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "postgresTable": {
          "host": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "mysqlTable": {
          "host": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "clickhouseTable": {
          "host": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        },
        "airflowTask": {
          "integrationId": "<string>",
          "dagId": "<string>",
          "taskId": "<string>"
        },
        "custom": {
          "id": "<string>"
        },
        "dataproduct": {
          "id": "<string>"
        },
        "synqPath": {
          "path": "<string>"
        },
        "databricksTable": {
          "workspace": "<string>",
          "catalog": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "trinoTable": {
          "host": "<string>",
          "catalog": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "sqlMeshModel": {
          "integrationId": "<string>",
          "fqn": "<string>"
        },
        "sqlMeshAudit": {
          "integrationId": "<string>",
          "fqn": "<string>",
          "auditId": "<string>"
        },
        "monitor": {
          "monitoredId": {},
          "monitorId": "<string>",
          "segment": "<string>",
          "integrationId": "<string>"
        }
      },
      "explanation": "<string>",
      "entitySynqPath": "<string>",
      "id": "<string>",
      "notNullTest": {
        "columnNames": [
          "<string>"
        ]
      },
      "emptyTest": {
        "columnNames": [
          "<string>"
        ]
      },
      "acceptedValuesTest": {
        "columnName": "<string>",
        "acceptedValues": [
          "<string>"
        ]
      },
      "rejectedValuesTest": {
        "columnName": "<string>",
        "rejectedValues": [
          "<string>"
        ]
      },
      "uniqueTest": {
        "columnNames": [
          "<string>"
        ],
        "timePartitionColumnName": "<string>",
        "timeWindowSeconds": "<string>"
      },
      "freshnessTest": {
        "timePartitionColumnName": "<string>",
        "timeWindowSeconds": "<string>"
      },
      "rowCountTest": {},
      "minMaxTest": {
        "columnName": "<string>",
        "minValue": 123,
        "maxValue": 123
      },
      "relativeTimeTest": {
        "columnName": "<string>",
        "relativeColumnName": "<string>"
      },
      "businessRuleTest": {
        "sqlExpression": "<string>"
      },
      "minValueTest": {
        "columnName": "<string>",
        "minValue": 123
      },
      "maxValueTest": {
        "columnName": "<string>",
        "maxValue": 123
      }
    }
  ]
}'
{}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Response

200
application/json

OK

The response is of type object.