Test new destination connection
curl --request POST \
--url https://api.prequel.co/test-destination \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"destination": {
"vendor": "<unknown>",
"abs": {
"folder": "<string>",
"container_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "azure_service_shared_access_signature",
"file_format": "parquet",
"disable_manifest": false
},
"name": "<string>",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled_models": [
"<string>"
],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": true,
"machine_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.prequel.co/test-destination"
payload = { "destination": {
"vendor": "<unknown>",
"abs": {
"folder": "<string>",
"container_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "azure_service_shared_access_signature",
"file_format": "parquet",
"disable_manifest": False
},
"name": "<string>",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled_models": ["<string>"],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": True,
"machine_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: {
vendor: '<unknown>',
abs: {
folder: '<string>',
container_name: '<string>',
storage_account_name: '<string>',
auth_method: 'azure_service_shared_access_signature',
file_format: 'parquet',
disable_manifest: false
},
name: '<string>',
recipient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled_models: ['<string>'],
max_concurrent_transfers: 123,
max_concurrent_queries_per_transfer: 123,
is_enabled: true,
machine_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.prequel.co/test-destination', 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://api.prequel.co/test-destination",
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([
'destination' => [
'vendor' => '<unknown>',
'abs' => [
'folder' => '<string>',
'container_name' => '<string>',
'storage_account_name' => '<string>',
'auth_method' => 'azure_service_shared_access_signature',
'file_format' => 'parquet',
'disable_manifest' => false
],
'name' => '<string>',
'recipient_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled_models' => [
'<string>'
],
'max_concurrent_transfers' => 123,
'max_concurrent_queries_per_transfer' => 123,
'is_enabled' => true,
'machine_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api.prequel.co/test-destination"
payload := strings.NewReader("{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.prequel.co/test-destination")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/test-destination")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"destination": {
"abs": {
"folder": "<string>",
"container_name": "<string>",
"auth_method": "<string>",
"storage_account_name": "<string>",
"disable_manifest": true,
"csv": {
"delimiter": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"recipient_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_successful_transfer_ended_at": "2023-11-07T05:31:56Z",
"frequency_minutes": 123,
"id_in_provider_system": "<string>",
"products": [
"<string>"
],
"enabled_models": [
"<string>"
],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": true,
"last_completed_transfer": {
"id": "<string>",
"status": "<string>",
"is_full_refresh": true,
"models": [
"<string>"
],
"log": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"start_transfer_window_at": "2023-11-07T05:31:56Z",
"end_transfer_window_at": "2023-11-07T05:31:56Z",
"rows_transferred": 123,
"delta_rows_transferred": 123,
"volume_transferred_in_mb": 123,
"is_debug_mode": true,
"actor_id": "<string>",
"actor_type": "<string>",
"source_ids": [
"<string>"
],
"destination_id": "<string>",
"model_metrics": [
{
"model_id": "<string>",
"rows_transferred": 123,
"delta_rows_transferred": 123,
"volume_transferred_in_mb": 123,
"start_transfer_window_at": "2023-11-07T05:31:56Z",
"end_transfer_window_at": "2023-11-07T05:31:56Z",
"most_recent_last_updated_at": "2023-11-07T05:31:56Z",
"error": {
"error": "<unknown>",
"error_code": "<string>",
"title": "<string>",
"blame": "<string>",
"documentation_url": "<string>",
"trace": "<string>",
"message": "<string>"
},
"model_name": "<string>"
}
],
"models_snapshot": [
{
"model_id": "<string>",
"model_name": "<string>",
"revision_id": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"tags": {}
},
"total_rows_transferred_last_billing_period": 123,
"total_delta_rows_transferred_last_billing_period": 123,
"total_rows_transferred_current_billing_period": 123
}
},
"message": "<string>"
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}Destinations
Test new destination connection
Test the connection for a new destination before creating it.
POST
/
test-destination
Test new destination connection
curl --request POST \
--url https://api.prequel.co/test-destination \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"destination": {
"vendor": "<unknown>",
"abs": {
"folder": "<string>",
"container_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "azure_service_shared_access_signature",
"file_format": "parquet",
"disable_manifest": false
},
"name": "<string>",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled_models": [
"<string>"
],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": true,
"machine_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.prequel.co/test-destination"
payload = { "destination": {
"vendor": "<unknown>",
"abs": {
"folder": "<string>",
"container_name": "<string>",
"storage_account_name": "<string>",
"auth_method": "azure_service_shared_access_signature",
"file_format": "parquet",
"disable_manifest": False
},
"name": "<string>",
"recipient_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled_models": ["<string>"],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": True,
"machine_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
destination: {
vendor: '<unknown>',
abs: {
folder: '<string>',
container_name: '<string>',
storage_account_name: '<string>',
auth_method: 'azure_service_shared_access_signature',
file_format: 'parquet',
disable_manifest: false
},
name: '<string>',
recipient_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
enabled_models: ['<string>'],
max_concurrent_transfers: 123,
max_concurrent_queries_per_transfer: 123,
is_enabled: true,
machine_type_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.prequel.co/test-destination', 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://api.prequel.co/test-destination",
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([
'destination' => [
'vendor' => '<unknown>',
'abs' => [
'folder' => '<string>',
'container_name' => '<string>',
'storage_account_name' => '<string>',
'auth_method' => 'azure_service_shared_access_signature',
'file_format' => 'parquet',
'disable_manifest' => false
],
'name' => '<string>',
'recipient_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'enabled_models' => [
'<string>'
],
'max_concurrent_transfers' => 123,
'max_concurrent_queries_per_transfer' => 123,
'is_enabled' => true,
'machine_type_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://api.prequel.co/test-destination"
payload := strings.NewReader("{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://api.prequel.co/test-destination")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.prequel.co/test-destination")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"destination\": {\n \"vendor\": \"<unknown>\",\n \"abs\": {\n \"folder\": \"<string>\",\n \"container_name\": \"<string>\",\n \"storage_account_name\": \"<string>\",\n \"auth_method\": \"azure_service_shared_access_signature\",\n \"file_format\": \"parquet\",\n \"disable_manifest\": false\n },\n \"name\": \"<string>\",\n \"recipient_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"enabled_models\": [\n \"<string>\"\n ],\n \"max_concurrent_transfers\": 123,\n \"max_concurrent_queries_per_transfer\": 123,\n \"is_enabled\": true,\n \"machine_type_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"data": {
"destination": {
"abs": {
"folder": "<string>",
"container_name": "<string>",
"auth_method": "<string>",
"storage_account_name": "<string>",
"disable_manifest": true,
"csv": {
"delimiter": "<string>"
}
},
"id": "<string>",
"vendor": "<string>",
"name": "<string>",
"recipient_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"last_successful_transfer_ended_at": "2023-11-07T05:31:56Z",
"frequency_minutes": 123,
"id_in_provider_system": "<string>",
"products": [
"<string>"
],
"enabled_models": [
"<string>"
],
"max_concurrent_transfers": 123,
"max_concurrent_queries_per_transfer": 123,
"is_enabled": true,
"last_completed_transfer": {
"id": "<string>",
"status": "<string>",
"is_full_refresh": true,
"models": [
"<string>"
],
"log": "<string>",
"submitted_at": "2023-11-07T05:31:56Z",
"start_transfer_window_at": "2023-11-07T05:31:56Z",
"end_transfer_window_at": "2023-11-07T05:31:56Z",
"rows_transferred": 123,
"delta_rows_transferred": 123,
"volume_transferred_in_mb": 123,
"is_debug_mode": true,
"actor_id": "<string>",
"actor_type": "<string>",
"source_ids": [
"<string>"
],
"destination_id": "<string>",
"model_metrics": [
{
"model_id": "<string>",
"rows_transferred": 123,
"delta_rows_transferred": 123,
"volume_transferred_in_mb": 123,
"start_transfer_window_at": "2023-11-07T05:31:56Z",
"end_transfer_window_at": "2023-11-07T05:31:56Z",
"most_recent_last_updated_at": "2023-11-07T05:31:56Z",
"error": {
"error": "<unknown>",
"error_code": "<string>",
"title": "<string>",
"blame": "<string>",
"documentation_url": "<string>",
"trace": "<string>",
"message": "<string>"
},
"model_name": "<string>"
}
],
"models_snapshot": [
{
"model_id": "<string>",
"model_name": "<string>",
"revision_id": "<string>"
}
],
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"tags": {}
},
"total_rows_transferred_last_billing_period": 123,
"total_delta_rows_transferred_last_billing_period": 123,
"total_rows_transferred_current_billing_period": 123
}
},
"message": "<string>"
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}{
"status": "<string>",
"message": "<string>",
"data": null
}Authorizations
Body
application/json
- Azure Blob Storage
- Amazon Athena
- Amazon Aurora MySQL
- Amazon Aurora PostgreSQL
- Google BigQuery
- ClickHouse
- Databricks
- Delta Lake
- Google Cloud Storage
- Google Sheets
- Iceberg
- Mock (for testing in staging only)
- MongoDB
- MotherDuck
- MySQL
- Oracle
- PlanetScale
- PostgreSQL
- Amazon Redshift
- Amazon Redshift Serverless
- SFTP
- SingleStore
- Snowflake
- SQL Server
- Amazon S3
- S3 Compatible
Show child attributes
Show child attributes
⌘I