Skip to main content
GET
Get mapping preview

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

mapping_id
string<uuid>
required

Unique identifier for a mapping.

Query Parameters

size
integer
default:100

The number of rows to sample from the dataset. Defaults to 100 when omitted.

Required range: x <= 1000

Response

200 - application/json

OK

Sampled rows with the mapping applied, one object per row.

Every record carries both an input and an output. applyMapping builds each row by nesting the source columns under input and the mapped columns under output before serializing, so neither key is ever absent. Their contents are open maps: input is keyed by dataset field name and output by attribute name, both of which vary per request.

A cached_mapping is resolved as a join at query time and has no per-row preview, so records is empty for one.

records
object[]
required