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>"
  ]
}
'
{
  "status": "<string>",
  "data": {
    "schema": [
      {
        "name": "<string>",
        "database_type_name": "<string>",
        "length": 123,
        "precision": 123,
        "scale": 123,
        "nullable": true
      }
    ],
    "records": [
      "<unknown>"
    ]
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://import-docs.prequel.co/llms.txt

Use this file to discover all available pages before exploring further.

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