Skip to navigation
Sigma REST APIWorkbooksexport schedules

Add workbook schedule

View as Markdown

Add a schedule to a workbook to export data from the workbook on a periodic basis.

Usage notes

  • Retrieve the workbookId by calling the /v2/workbooks endpoint.

  • Retrieve relevant IDs based on the export contents and destination:

    • To export to one or more Sigma users, retrieve the memberId by calling the /v2/members endpoint.
    • To export to one or more Sigma teams, retrieve the teamId by calling the /v2/teams endpoint.

  • Retrieve the pageId by calling the /v2/workbooks/{workbookId}/pages endpoint.

  • Retrieve the elementId by first calling the /v2/workbooks/{workbookId}/pages endpoint, then calling the /v2/workbooks/{workbookId}/pages/{pageId}/elements endpoint.

  • Email burst is not available for trial organizations.

  • To schedule an email burst, set configV2.exportDestination to email-burst and list split-by controls in configV2.dynamicExportSettings.variables. Provide recipients in target, or set dynamicRecipientSettings to resolve recipients per control value.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

workbookIdstringRequired
Unique identifier of the workbook.

Request

The request body.
targetlist of objectsRequired
One or more targets to send the workbook to.
scheduleobjectRequired
When to send the workbook export.
configV2objectOptional
Configuration settings for the export schedule.
configobjectOptional

[Deprecated] Configuration settings for the export.

descriptionstring or nullOptional
Description of the scheduled export
ownerIdstringOptional

ID of the user (member) to own the export.

Response

The response body.
scheduledNotificationIdstring
Unique identifier of the scheduled export.
workbookIdstring
Unique identifier of the workbook.
scheduleobject
configV2object
isSuspendedboolean
Whether the schedule is currently suspended.
ownerIdstring
Unique identifier of the user who owns the schedule.
lastUpdatedByUserstring
Unique identifier of the user who last updated the schedule.
disabledAtdatetime or null
Timestamp when the schedule was disabled, or null if the schedule is active.
disabledBystring or null
Unique identifier of the member who disabled the schedule, or null if the schedule is active.
createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.