Skip to navigation
Sigma REST APIWorkbooksexports

Export a workbook

View as Markdown

Export a workbook to one or more destinations, such as an email address, a Slack channel, or cloud storage.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.
  • This endpoint is rate limited to 100 requests per minute.
  • Email and download bursts are limited to 5 requests per minute.
  • Email burst and download burst are not available for trial organizations.
  • To send an email burst, set configV2.exportDestination to email-burst and list the controls to split by in configV2.dynamicExportSettings.variables. Provide recipients in target, or set dynamicRecipientSettings to resolve recipients per control value.
  • To send a download burst, set configV2.exportDestination to burst-download and list the controls to split by in configV2.dynamicExportSettings.variables. Do not include recipients, Sigma emails a download link for the split files to the user making the request.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Request

The request body.
configV2objectRequired

Export using target and configV2.

OR
Legacy export (Deprecated)objectRequired

[Deprecated] Use target and configV2 instead of targets, config, and attachments.

Response

The response body.