SymetryML Documentation
Data sources

Preview data sample

Preview data from a data source before creating it. Useful for validating data source configuration and examining data structure, column names, and sample values. The request body has the same encrypted **DSInfo** shape for every data source type (`s3`, `redshift`, `localfile`, etc.) — see [Create new data source](/docs/api-reference/data-sources/dss-create-post) for decrypted-equivalent examples covering all supported types.

POST
/{user}/dss/sample/preview

Preview data from a data source before creating it. Useful for validating data source configuration and examining data structure, column names, and sample values.

The request body has the same encrypted DSInfo shape for every data source type (s3, redshift, localfile, etc.) — see Create new data source for decrypted-equivalent examples covering all supported types.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Base64-encoded encrypted content. It is an encrypted DSInfo object, not a plain JSON object — the encryption is performed outside the API, using a symmetric key known to both client and server.

Response Body

application/json

curl -X POST "https://example.com/c1/dss/sample/preview" \  -H "Content-Type: application/json" \  -d 'hZVLWVA2VczyB572ZSMl3bhwMGlCN1Eh4VYYAsDQQqyI8vCCexofRRfTawYUFGAEsncCKIiWJ/OXilhTpQQBDknw95iqMbsHtM7mvguzkJK8M9HKmzDvuTg1cGQEsdgcTRDOP4Zm8OxUOeJJNB6AT6oR2muP43D6iKmQpguJuQOgfxGJPdUxH4EI7=='
{  "statusCode": 200,  "statusString": "OK",  "values": {    "dataframe": {      "attributeNames": [        "CRIM",        "ZN",        "INDUS",        "CHAS",        "NOX",        "RM",        "AGE",        "DIS",        "RAD",        "TAX",        "PTRATIO",        "B",        "LSTAT",        "MEDV"      ],      "data": [        [          "0.00632",          "18",          "2.31",          "0",          "0.538",          "6.575",          "65.2",          "4.09",          "1",          "296",          "15.3",          "396.9",          "4.98",          "24"        ],        [          "0.02731",          "0",          "7.07",          "0",          "0.469",          "6.421",          "78.9",          "4.9671",          "2",          "242",          "17.8",          "396.9",          "9.14",          "21.6"        ]      ],      "attributeTypes": [        "C",        "C",        "C",        "B",        "C",        "C",        "C",        "C",        "C",        "C",        "C",        "C",        "C",        "C"      ],      "errorHandling": 1    }  }}