GET
/
api
/
datachecks
/
testsuggestions
/
v1
BatchGetTestSuggestionsForEntities
curl --request GET \
  --url https://developer.synq.io/api/datachecks/testsuggestions/v1 \
  --header 'Authorization: Bearer <token>'
{
  "suggestions": [
    {
      "acceptedValuesTest": {
        "columnName": "<string>",
        "acceptedValues": [
          "<string>"
        ]
      },
      "identifier": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "explanation": "<string>",
      "entitySynqPath": "<string>",
      "id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
identifiers.dbtCoreNode.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
identifiers.dbtCoreNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
identifiers.dbtCloudNode.projectId
string
required

Your dbt Cloud project id

​
identifiers.dbtCloudNode.accountId
string

Your dbt Cloud account id

​
identifiers.dbtCloudNode.nodeId
string
required

Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​
identifiers.bigqueryTable.project
string
required

BigQuery project

​
identifiers.bigqueryTable.dataset
string
required

BigQuery dataset id

​
identifiers.bigqueryTable.table
string
required

BigQuery table name

​
identifiers.snowflakeTable.account
string
required

Snowflake account

​
identifiers.snowflakeTable.database
string
required

Snowflake database

​
identifiers.snowflakeTable.schema
string
required

Snowflake schema

​
identifiers.snowflakeTable.table
string
required

Snowflake table

​
identifiers.redshiftTable.cluster
string

Redshift cluster

​
identifiers.redshiftTable.database
string
required

Redshift database

​
identifiers.redshiftTable.schema
string
required

Redshift schema

​
identifiers.redshiftTable.table
string
required

Redshift table

​
identifiers.postgresTable.host
string
required

Postgres hostname without port

​
identifiers.postgresTable.database
string
required

Postgres database

​
identifiers.postgresTable.schema
string
required

Postgres schema

​
identifiers.postgresTable.table
string
required

Postgres table

​
identifiers.mysqlTable.host
string
required

Mysql hostname without port

​
identifiers.mysqlTable.schema
string
required

Mysql database

​
identifiers.mysqlTable.table
string
required

Mysql table

​
identifiers.clickhouseTable.host
string
required

Clickhouse hostname without port

​
identifiers.clickhouseTable.schema
string
required

Clickhouse database

​
identifiers.clickhouseTable.table
string
required

Clickhouse table

​
identifiers.airflowDag.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
identifiers.airflowDag.dagId
string
required

Airflow dag_id that identifies the DAG

​
identifiers.airflowTask.integrationId
string
required

SYNQ integration_id that identifies the Airflow instance

​
identifiers.airflowTask.dagId
string
required

Airflow dag_id that identifies the DAG

​
identifiers.airflowTask.taskId
string
required

Airflow task_id that identifies the task within the DAG

​
identifiers.custom.id
string
required

Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

​
identifiers.dataproduct.id
string
required

Dataproduct id that identifies the Dataproduct

​
identifiers.synqPath.path
string
required

SYNQ path that identifies the SYNQ entity, needs to be one of supported paths

​
identifiers.databricksTable.workspace
string
required

URL of Databricks workspace

​
identifiers.databricksTable.catalog
string
required

Databricks catalog

​
identifiers.databricksTable.schema
string
required

Databricks schema

​
identifiers.databricksTable.table
string
required

Databricks table or view

​
identifiers.trinoTable.host
string
required

Hostname of the Trino instance

​
identifiers.trinoTable.catalog
string
required

Trino catalog

​
identifiers.trinoTable.schema
string
required

Trino schema

​
identifiers.trinoTable.table
string
required

Trino table or view

​
identifiers.sqlMeshModel.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
identifiers.sqlMeshModel.fqn
string
required

SQLMesh model fully qualified name

​
identifiers.sqlMeshAudit.integrationId
string
required

SYNQ integration_id that identifies the dbt Core project

​
identifiers.sqlMeshAudit.fqn
string
required

SQLMesh model fully qualified name

​
identifiers.sqlMeshAudit.auditId
string
required

Identifier of the audit

​
identifiers.monitor.monitorId
string
required

Identifier of the monitor

​
identifiers.monitor.segment
string

Optional monitor segmentation identifier

​
identifiers.monitor.integrationId
string
deprecated

SYNQ integration_id of the monitored identifier

Response

200
application/json

Success

The response is of type object.