Initiate export of a dataset to the given connector.

post https://api.gigasheet.com/connectors/{handle}/export

Initiates an export of the dataset to the given connector.

Path Params

handle

string

required

handle to export

Body Params

Request fields

asLiveView

boolean

callbackUrl

string

clientState

object

compressionType

string

Defaults to zip

decompress

boolean

Defaults to false

filename

string

folderHandle

string

gridState

object

required

params

string

recordsPerFile

integer

row_limit_from_head

integer

singlePivotHeader

boolean

skipNotification

boolean

Defaults to false

sourceType

string

useClientState

boolean

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

Responses

Language

Credentials

Header


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://api.gigasheet.com/connectors/handle/export \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "compressionType": "zip",
8
  "decompress": false,
9
  "skipNotification": false
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error