ListSqlTests
curl --request GET \
--url https://developer.synq.io/api/datachecks/sqltests/v1 \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/datachecks/sqltests/v1"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/datachecks/sqltests/v1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/datachecks/sqltests/v1")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"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": [
{
"fqn": {
"objectName": "<string>",
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>"
},
"tablePath": "<string>"
}
]
}
]
}synq.datachecks.sqltests.v1.SqlTestsService
ListSqlTests
List SqlTests for given annotations.
GET
/
api
/
datachecks
/
sqltests
/
v1
ListSqlTests
curl --request GET \
--url https://developer.synq.io/api/datachecks/sqltests/v1 \
--header 'Authorization: Bearer <token>'import requests
url = "https://developer.synq.io/api/datachecks/sqltests/v1"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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 => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://developer.synq.io/api/datachecks/sqltests/v1"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://developer.synq.io/api/datachecks/sqltests/v1")
.header("Authorization", "Bearer <token>")
.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::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"pageInfo": {
"totalCount": 123,
"count": 123,
"lastId": "<string>"
},
"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": [
{
"fqn": {
"objectName": "<string>",
"instanceName": "<string>",
"databaseName": "<string>",
"schemaName": "<string>"
},
"tablePath": "<string>"
}
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
String key for the annotation.
Required string length:
1 - 50Optional list of values that the annotation can carry.
Maximum array length:
20Required string length:
1 - 50Available options:
SOURCE_APP, SOURCE_API Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.
Maximum number of items to return in a single page. If not provided, defaults vary per API.
Required range:
x >= 0⌘I