SIsigmacomputing
Workbooks

Add workbook schedule

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.

post/v2/workbooks/{workbookId}/schedules

Request

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

Path parameters

workbookIdstring required

Unique identifier of the workbook.

Request body

descriptionstring nullable

Description of the scheduled export

ownerIdstring

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

Response

The response body.

scheduledNotificationIdstring required

Unique identifier of the scheduled export.

workbookIdstring required

Unique identifier of the workbook.

isSuspendedboolean required

Whether the schedule is currently suspended.

ownerIdstring required

Unique identifier of the user who owns the schedule.

lastUpdatedByUserstring required

Unique identifier of the user who last updated the schedule.

disabledAtstring date-time nullable required

Timestamp when the schedule was disabled, or null if the schedule is active.

disabledBystring nullable required

Unique identifier of the member who disabled the schedule, or null if the schedule is active.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

Changes

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