Get Started
Monitors
Monitors Types
Incidents
Analytics
Data Warehouse Integrations
dbt Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Support
curl --request POST \
--url https://developer.synq.io/api/datachecks/sqltests/v1/by-id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"<string>"
]
}
'{
"sqlTests": {}
}BatchGetSqlTests
Get SqlTests by their IDs.
curl --request POST \
--url https://developer.synq.io/api/datachecks/sqltests/v1/by-id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"<string>"
]
}
'{
"sqlTests": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
IDs of the SqlTests to fetch.
Response
Success
Show child attributes
Show child attributes
The SqlTest is a SQL test that is executed on a synq entity. sql_test_requires_expression_or_suggestion // exactly one of sql_expression or template must be provided, but not both sql_test_requires_platform_or_template // at least one of platform or template identifier must be provided
Show child attributes
Show child attributes
Unique resource identifier for the SqlTest. This is externally maintained and can be used to fetch/update/delete this test.
Human friendly name.
Identifier for the data platform which the SqlTest would be executed on.
Description of purpose and motivation.
SEVERITY_UNSPECIFIED, SEVERITY_WARNING, SEVERITY_ERROR, SEVERITY_INFO A valid SQL expression which is the test.
Recurrence rule for the execution schedule of the SqlTest.
Annotations for the given SqlTest.These help filter the SqlTests for later operations like listing by API, selection in UI, analytics, etc.
Boolean flag to to toggle saving of failure runs.
Template for the SqlTest. required when sql_expression is not provided
- Template
- Template
- Template
- Template
- Template
- Template
- Template
- Template
- Template
- Template
- Template
Show child attributes
Show child attributes
Read-only path of matched entity. This is a unique path that can be used to access the entity in the Synq's UI.
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
- identifier
Show child attributes
Show child attributes
Validates that column values are within an allowed set (e.g., status in ['active', 'inactive', 'pending'])
Show child attributes
Show child attributes
Name of the column to validate
List of allowed values for the column
1Represents a value that can be either a literal (to be quoted in SQL) or a SQL expression (to be used as plain text).
- SqlValue
- SqlValue
Show child attributes
Show child attributes
Literal value that should be quoted in SQL (e.g., '2025-05-12', 'active')
SQL expression, numbers to be used as plain text (e.g., NOW(), COUNT(*), true, 1.1)
Config ID for the SqlTest.
SOURCE_APP, SOURCE_API