Sign in

v1

latestOpenAPI 3.0.02026-07-14184214216.1 KB
data

Initiate export of a dataset to the given connector.

Initiates an export of the dataset to the given connector.

post/connectors/{handle}/export

Path parameters

handlestring required

handle to export

Request body

asLiveViewboolean
callbackUrlstring
compressionType'zip' | 'gzip'
decompressboolean
filenamestring
folderHandlestring
{"stackTrail":"components:schemas:livequery.ExportRequest:properties:params","oasType":"schema","type":"unknown"}
recordsPerFileinteger
row_limit_from_headinteger
singlePivotHeaderboolean
skipNotificationboolean
sourceType'snowflake' | 'snowflakeSSO' | 'snowflakeLiveQuery' | 'snowflakeSSOLiveQuery' | 'google-analytics-data-api' | 'hubspot' | 'mysql' | 'postgres' | 'salesforce' | 'salesforceReport' | 'freshsales' | 'databricks' | 'databricksDeltaShare' | 'databricksLiveQuery' | 'bigquery' | 'awsathena' | 'awsredshift' | 'mssql' | 'clickhouse' | 'clickhouseLiveQuery'
useClientStateboolean

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

Response

OK

ConsentURLstring
{"stackTrail":"components:schemas:nexus.Response:properties:Error","oasType":"schema","type":"unknown"}
HandlesNexusHandleMap
Messagestring
Successboolean