Workbooks

Export a workbook

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.
post/v2/workbooks/{workbookId}/send

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Request body

OR

Response

The response body.

WorkbooksSendWorkbookResponse200 required

Changes

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