Skip to main content
POST
/
import
/
test-stream
Test new stream
curl --request POST \
  --url https://api.prequel.co/import/test-stream \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "stream": {
    "name": "<string>",
    "destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "mappings": [
      {
        "field_type": "<string>",
        "target_field": "<string>",
        "column": {},
        "expression": {}
      }
    ],
    "is_enabled": false
  },
  "record_ids": [
    "<string>"
  ]
}
'
import requests

url = "https://api.prequel.co/import/test-stream"

payload = {
"stream": {
"name": "<string>",
"destination_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dataset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mappings": [
{
"field_type": "<string>",
"target_field": "<string>",
"column": {},
"expression": {}
}
],
"is_enabled": False
},
"record_ids": ["<string>"]
}
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({
stream: {
name: '<string>',
destination_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dataset_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mappings: [{field_type: '<string>', target_field: '<string>', column: {}, expression: {}}],
is_enabled: false
},
record_ids: ['<string>']
})
};

fetch('https://api.prequel.co/import/test-stream', 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/import/test-stream",
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([
'stream' => [
'name' => '<string>',
'destination_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dataset_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mappings' => [
[
'field_type' => '<string>',
'target_field' => '<string>',
'column' => [

],
'expression' => [

]
]
],
'is_enabled' => false
],
'record_ids' => [
'<string>'
]
]),
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/import/test-stream"

payload := strings.NewReader("{\n \"stream\": {\n \"name\": \"<string>\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mappings\": [\n {\n \"field_type\": \"<string>\",\n \"target_field\": \"<string>\",\n \"column\": {},\n \"expression\": {}\n }\n ],\n \"is_enabled\": false\n },\n \"record_ids\": [\n \"<string>\"\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/import/test-stream")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"stream\": {\n \"name\": \"<string>\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mappings\": [\n {\n \"field_type\": \"<string>\",\n \"target_field\": \"<string>\",\n \"column\": {},\n \"expression\": {}\n }\n ],\n \"is_enabled\": false\n },\n \"record_ids\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.prequel.co/import/test-stream")

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 \"stream\": {\n \"name\": \"<string>\",\n \"destination_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dataset_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mappings\": [\n {\n \"field_type\": \"<string>\",\n \"target_field\": \"<string>\",\n \"column\": {},\n \"expression\": {}\n }\n ],\n \"is_enabled\": false\n },\n \"record_ids\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "<string>",
  "data": {
    "schema": [
      {
        "name": "<string>",
        "database_type_name": "<string>",
        "length": 123,
        "precision": 123,
        "scale": 123,
        "nullable": true
      }
    ],
    "records": [
      "<unknown>"
    ]
  },
  "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

X-API-KEY
string
header
required

Body

application/json
stream
Stream · object
required

Candidate stream definition to test.

record_ids
string[]
required

List of specific record IDs to test the transformation against.

Required array length: 1 - 100 elements

Response

OK

status
string
required
Allowed value: "success"
data
object
required
message
string
required