curl --request GET \
--url https://developer.synq.io/api/datachecks/sqltests/v1 \
--header 'Authorization: Bearer <token>'{
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"sqlTests": [
{
"id": "<string>",
"name": "<string>",
"platform": {
"bigquery": {
"project": "<string>"
}
},
"description": "<string>",
"severity": "SEVERITY_UNSPECIFIED",
"sqlExpression": "<string>",
"recurrenceRule": "<string>",
"annotations": [
{
"name": "<string>",
"values": [
"<string>"
]
}
],
"saveFailures": true,
"template": {
"identifier": {
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
},
"acceptedValuesTest": {
"columnName": "<string>",
"acceptedValues": [
{
"stringLiteral": "<string>",
"expression": "<string>"
}
]
}
},
"configId": "<string>",
"source": "SOURCE_APP"
}
]
}List SqlTests for given annotations.
curl --request GET \
--url https://developer.synq.io/api/datachecks/sqltests/v1 \
--header 'Authorization: Bearer <token>'{
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"sqlTests": [
{
"id": "<string>",
"name": "<string>",
"platform": {
"bigquery": {
"project": "<string>"
}
},
"description": "<string>",
"severity": "SEVERITY_UNSPECIFIED",
"sqlExpression": "<string>",
"recurrenceRule": "<string>",
"annotations": [
{
"name": "<string>",
"values": [
"<string>"
]
}
],
"saveFailures": true,
"template": {
"identifier": {
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
},
"acceptedValuesTest": {
"columnName": "<string>",
"acceptedValues": [
{
"stringLiteral": "<string>",
"expression": "<string>"
}
]
}
},
"configId": "<string>",
"source": "SOURCE_APP"
}
]
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
String key for the annotation.
1 - 100Optional list of values that the annotation can carry.
201 - 100SOURCE_APP, SOURCE_API Cursor for the next page of results. If not provided, returns the first page.
Maximum number of items to return in a single page. If not provided, defaults vary per API.
x >= 0Success
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
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.
Show child attributes
Validates that column values are within an allowed set (e.g., status in ['active', 'inactive', 'pending'])
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).
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