Skip to main content
POST
/
api
/
datachecks
/
sqltests
/
v1
BatchUpsertSqlTests
curl --request POST \
  --url https://developer.synq.io/api/datachecks/sqltests/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sqlTests": [
    {
      "id": "<string>",
      "name": "<string>",
      "platform": {
        "athena": {
          "instance": "<string>",
          "catalog": "<string>"
        }
      },
      "description": "<string>",
      "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>"
            }
          ],
          "selectColumns": [
            "<string>"
          ]
        }
      },
      "configId": "<string>",
      "timezone": "<string>",
      "evaluators": [
        {
          "id": "<string>",
          "name": "<string>",
          "sqlExpression": "<string>"
        }
      ],
      "inputTables": [
        {
          "tablePath": "<string>"
        }
      ]
    }
  ],
  "sqlTestIdsToReset": [
    "<string>"
  ]
}
'
import requests

url = "https://developer.synq.io/api/datachecks/sqltests/v1"

payload = {
    "sqlTests": [
        {
            "id": "<string>",
            "name": "<string>",
            "platform": { "athena": {
                    "instance": "<string>",
                    "catalog": "<string>"
                } },
            "description": "<string>",
            "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>"
                        }
                    ],
                    "selectColumns": ["<string>"]
                }
            },
            "configId": "<string>",
            "timezone": "<string>",
            "evaluators": [
                {
                    "id": "<string>",
                    "name": "<string>",
                    "sqlExpression": "<string>"
                }
            ],
            "inputTables": [{ "tablePath": "<string>" }]
        }
    ],
    "sqlTestIdsToReset": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    sqlTests: [
      {
        id: '<string>',
        name: '<string>',
        platform: {athena: {instance: '<string>', catalog: '<string>'}},
        description: '<string>',
        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>'}],
            selectColumns: ['<string>']
          }
        },
        configId: '<string>',
        timezone: '<string>',
        evaluators: [{id: '<string>', name: '<string>', sqlExpression: '<string>'}],
        inputTables: [{tablePath: '<string>'}]
      }
    ],
    sqlTestIdsToReset: ['<string>']
  })
};

fetch('https://developer.synq.io/api/datachecks/sqltests/v1', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://developer.synq.io/api/datachecks/sqltests/v1",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'sqlTests' => [
        [
                'id' => '<string>',
                'name' => '<string>',
                'platform' => [
                                'athena' => [
                                                                'instance' => '<string>',
                                                                'catalog' => '<string>'
                                ]
                ],
                'description' => '<string>',
                '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>'
                                                                                                                                ]
                                                                ],
                                                                'selectColumns' => [
                                                                                                                                '<string>'
                                                                ]
                                ]
                ],
                'configId' => '<string>',
                'timezone' => '<string>',
                'evaluators' => [
                                [
                                                                'id' => '<string>',
                                                                'name' => '<string>',
                                                                'sqlExpression' => '<string>'
                                ]
                ],
                'inputTables' => [
                                [
                                                                'tablePath' => '<string>'
                                ]
                ]
        ]
    ],
    'sqlTestIdsToReset' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://developer.synq.io/api/datachecks/sqltests/v1"

	payload := strings.NewReader("{\n  \"sqlTests\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"platform\": {\n        \"athena\": {\n          \"instance\": \"<string>\",\n          \"catalog\": \"<string>\"\n        }\n      },\n      \"description\": \"<string>\",\n      \"sqlExpression\": \"<string>\",\n      \"recurrenceRule\": \"<string>\",\n      \"annotations\": [\n        {\n          \"name\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"saveFailures\": true,\n      \"template\": {\n        \"identifier\": {\n          \"airflowDag\": {\n            \"integrationId\": \"<string>\",\n            \"dagId\": \"<string>\"\n          }\n        },\n        \"acceptedValuesTest\": {\n          \"columnName\": \"<string>\",\n          \"acceptedValues\": [\n            {\n              \"stringLiteral\": \"<string>\",\n              \"expression\": \"<string>\"\n            }\n          ],\n          \"selectColumns\": [\n            \"<string>\"\n          ]\n        }\n      },\n      \"configId\": \"<string>\",\n      \"timezone\": \"<string>\",\n      \"evaluators\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"sqlExpression\": \"<string>\"\n        }\n      ],\n      \"inputTables\": [\n        {\n          \"tablePath\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"sqlTestIdsToReset\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://developer.synq.io/api/datachecks/sqltests/v1")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"sqlTests\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"platform\": {\n        \"athena\": {\n          \"instance\": \"<string>\",\n          \"catalog\": \"<string>\"\n        }\n      },\n      \"description\": \"<string>\",\n      \"sqlExpression\": \"<string>\",\n      \"recurrenceRule\": \"<string>\",\n      \"annotations\": [\n        {\n          \"name\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"saveFailures\": true,\n      \"template\": {\n        \"identifier\": {\n          \"airflowDag\": {\n            \"integrationId\": \"<string>\",\n            \"dagId\": \"<string>\"\n          }\n        },\n        \"acceptedValuesTest\": {\n          \"columnName\": \"<string>\",\n          \"acceptedValues\": [\n            {\n              \"stringLiteral\": \"<string>\",\n              \"expression\": \"<string>\"\n            }\n          ],\n          \"selectColumns\": [\n            \"<string>\"\n          ]\n        }\n      },\n      \"configId\": \"<string>\",\n      \"timezone\": \"<string>\",\n      \"evaluators\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"sqlExpression\": \"<string>\"\n        }\n      ],\n      \"inputTables\": [\n        {\n          \"tablePath\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"sqlTestIdsToReset\": [\n    \"<string>\"\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://developer.synq.io/api/datachecks/sqltests/v1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"sqlTests\": [\n    {\n      \"id\": \"<string>\",\n      \"name\": \"<string>\",\n      \"platform\": {\n        \"athena\": {\n          \"instance\": \"<string>\",\n          \"catalog\": \"<string>\"\n        }\n      },\n      \"description\": \"<string>\",\n      \"sqlExpression\": \"<string>\",\n      \"recurrenceRule\": \"<string>\",\n      \"annotations\": [\n        {\n          \"name\": \"<string>\",\n          \"values\": [\n            \"<string>\"\n          ]\n        }\n      ],\n      \"saveFailures\": true,\n      \"template\": {\n        \"identifier\": {\n          \"airflowDag\": {\n            \"integrationId\": \"<string>\",\n            \"dagId\": \"<string>\"\n          }\n        },\n        \"acceptedValuesTest\": {\n          \"columnName\": \"<string>\",\n          \"acceptedValues\": [\n            {\n              \"stringLiteral\": \"<string>\",\n              \"expression\": \"<string>\"\n            }\n          ],\n          \"selectColumns\": [\n            \"<string>\"\n          ]\n        }\n      },\n      \"configId\": \"<string>\",\n      \"timezone\": \"<string>\",\n      \"evaluators\": [\n        {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"sqlExpression\": \"<string>\"\n        }\n      ],\n      \"inputTables\": [\n        {\n          \"tablePath\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"sqlTestIdsToReset\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "createdIds": [
    "<string>"
  ],
  "updatedIds": [
    "<string>"
  ],
  "errors": [
    {
      "id": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
sqlTests
SqlTest · object[]

List of SqlTests to upsert. The upsert is performed based on the unique path provided for each SqlTest.

​
sqlTestIdsToReset
string[]

List of SqlTest IDs to reset. Some updates might require resetting the SqlTest to a fresh state.

Response

200 - application/json

Success

​
createdIds
string[]

IDs for which SqlTests were created without error.

​
updatedIds
string[]

IDs for which SqlTests were updated without error.

​
errors
UpsertError · object[]

Errors raised while upsert. This list will be empty if there were no errors.