v1

latestOpenAPI 3.0.02026-07-14184214216.1 KB

export

Create export

This will queue an export for the given sheet and return immediately with the handle for the export. The handle can be used with the "Download export" endpoint.

post/dataset/{handle}/export

Path parameters

handlestring required

sheet to export

Request body

callbackUrlstring

compressionType'zip' | 'gzip'

decompressboolean

filenamestring

folderHandlestring

recordsPerFileinteger

row_limit_from_headinteger

singlePivotHeaderboolean

skipNotificationboolean

useClientStateboolean

true to use the client state from request, otherwise, exporter will use the client state store

Response

{"stackTrail":"paths:/dataset/{handle}/export:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}