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

Request

Base URL
//api.gigasheet.com (relative, and the document’s source URL is not known)
Auth
API key in header X-GIGASHEET-TOKEN
TypeScript
https://skmtc.dev/freshdesk/apis/gigasheet-api/docs/dataset/:handle/export/post.ts
A function with typed inputs. Its response is checked against the schema.

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

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.