diff --git a/site/sigmaguides/src/embedding_rest_api_usage_02_bookmarks/embedding_rest_api_usage_02_bookmarks.md b/site/sigmaguides/src/embedding_rest_api_usage_02_bookmarks/embedding_rest_api_usage_02_bookmarks.md index d3025141..9d9ffa9a 100644 --- a/site/sigmaguides/src/embedding_rest_api_usage_02_bookmarks/embedding_rest_api_usage_02_bookmarks.md +++ b/site/sigmaguides/src/embedding_rest_api_usage_02_bookmarks/embedding_rest_api_usage_02_bookmarks.md @@ -74,7 +74,7 @@ Browse to the landing page: http://localhost:3000 ``` -Select the `API Embed Bookmarks` page and click `Go`: +Select the `Embed Bookmarks` page and click `Go`: @@ -192,8 +192,8 @@ The console log will list the bookmarks that were deleted: ```code Fetching bookmarks from Sigma API: https://aws-api.sigmacomputing.com/v2/workbooks/0e51172a-a4c0-4954-8c8c-9d854dcf4434/bookmarks Found 1 bookmarks in Sigma to delete -✅ Deleted Sigma bookmark: Mobile Phones (879c3131-eee6-4263-8df1-4e1a4be7178a) -✅ Clear all bookmarks completed - deleted 1 bookmarks +Deleted Sigma bookmark: Mobile Phones (879c3131-eee6-4263-8df1-4e1a4be7178a) +Clear all bookmarks completed - deleted 1 bookmarks ``` ![Footer](assets/sigma_footer.png) diff --git a/site/sigmaguides/src/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db.md b/site/sigmaguides/src/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db.md index 78613f57..0c83477b 100644 --- a/site/sigmaguides/src/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db.md +++ b/site/sigmaguides/src/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db/embedding_rest_api_usage_03_bookmark_sharing_with_a_local_db.md @@ -148,7 +148,7 @@ Browse to the landing page: http://localhost:3000 ``` -Select the `API Embed Bookmarks` page and click `Go`: +Select the `Embed Bookmarks with Local DB` page and click `Go`: @@ -306,14 +306,14 @@ Select the `Build` user and a workbook to target. The console log will list the bookmarks that were deleted: ```code Reusing cached bearer token -✅ Bearer token obtained for clear all operation +Bearer token obtained for clear all operation Fetching bookmarks from Sigma API: https://aws-api.sigmacomputing.com/v2/workbooks/0e51172a-a4c0-4954-8c8c-9d854dcf4434/bookmarks Found 3 bookmarks in Sigma to delete -✅ Deleted Sigma bookmark: Motorola Products (44a6f434-103e-40f7-bbc7-122089b73a38) -✅ Deleted Sigma bookmark: Apple Products (c9b16a2e-92c6-486c-9029-8b30ca0d1ee7) -✅ Deleted Sigma bookmark: Mobile Phones (9b8037f4-4900-4c58-adb9-043fd8696a87) -✅ Deleted 3 bookmarks from local database -✅ Total bookmarks deleted: 3 from Sigma, 3 from local DB +Deleted Sigma bookmark: Motorola Products (44a6f434-103e-40f7-bbc7-122089b73a38) +Deleted Sigma bookmark: Apple Products (c9b16a2e-92c6-486c-9029-8b30ca0d1ee7) +Deleted Sigma bookmark: Mobile Phones (9b8037f4-4900-4c58-adb9-043fd8696a87) +Deleted 3 bookmarks from local database +Total bookmarks deleted: 3 from Sigma, 3 from local DB ``` ![Footer](assets/sigma_footer.png) diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_01.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_01.png new file mode 100644 index 00000000..e082ff79 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_01.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_02.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_02.png new file mode 100644 index 00000000..bf4a1719 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_02.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_03.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_03.png new file mode 100644 index 00000000..cb5400df Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_03.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_04.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_04.png new file mode 100644 index 00000000..35198f5f Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_04.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_05.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_05.png new file mode 100644 index 00000000..14d1c66c Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_05.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_06.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_06.png new file mode 100644 index 00000000..dcf67f0f Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_06.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_07.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_07.png new file mode 100644 index 00000000..5ee14ac4 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_07.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_08.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_08.png new file mode 100644 index 00000000..15fdb708 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/api_export_08.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/caret.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/caret.png new file mode 100644 index 00000000..13a132ab Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/caret.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/closeview.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/closeview.png new file mode 100644 index 00000000..d0fbb0e4 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/closeview.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/crane.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/crane.png new file mode 100644 index 00000000..225ecf3f Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/crane.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/facebook.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/facebook.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/greencheckbox.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/heart_icon.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/heart_icon.png new file mode 100644 index 00000000..bff9ea90 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/heart_icon.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/horizonalline.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/linkedin.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/linkedin.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/sigma_footer.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/twitter.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/twitter.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/workflow.png b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/workflow.png new file mode 100644 index 00000000..30d13f15 Binary files /dev/null and b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/assets/workflow.png differ diff --git a/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/embedding_rest_api_usage_04_export_modal.md b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/embedding_rest_api_usage_04_export_modal.md new file mode 100644 index 00000000..fd9eb5a7 --- /dev/null +++ b/site/sigmaguides/src/embedding_rest_api_usage_04_export_modal/embedding_rest_api_usage_04_export_modal.md @@ -0,0 +1,195 @@ +author: pballai +id: embedding_rest_api_usage_04_export_modal +summary: embedding_rest_api_usage_04_export_modal +categories: embedding +environments: web +status: published +feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues +tags: default +lastUpdated: 2025-07-25 + +# REST API Usage 04: Scheduling Exports + +## Overview +Duration: 5 + +This QuickStart demonstrates how to extend an embedded Sigma workbook with scheduled export functionality using the Sigma REST API. + + + +Unlike basic embedding scenarios, this implementation provides users with export management capabilities directly within the host application. We won't cover every possibility, but we will cover these three core workflows: + +**1: Schedule an Export:**
+Allow users to create scheduled exports by configuring email recipients, subject lines, message content, export format (PDF, CSV, Excel), and delivery frequency (daily, weekly, monthly). The system handles `workbook ID` resolution and validates all parameters before creating the schedule via the Sigma API. + +**2: Manage Export Schedules:**
+Provide users with a management interface to view existing export schedules, edit configurations (with recipient re-entry for security compliance), delete unwanted schedules, and immediately trigger exports with custom recipient lists. + +**3: Send Now:**
+Enable users to send exports on-demand using existing schedule configurations, with the ability to specify different recipients for ad-hoc sharing without modifying the original schedule. + +This approach enables a complete export management experience directly within the embedded environment. It's especially useful for SaaS providers, internal dashboards, or any scenario where users need to share Sigma content via email without requiring direct access to the Sigma interface. + + + +[REST API Usage 01: Getting Started](https://quickstarts.sigmacomputing.com/guide/embedding_rest_api_usage_01_getting%20started_started/index.html?index=..%2F..index#0) + + + +For more information on Sigma's product release strategy, see [Sigma product releases](https://help.sigmacomputing.com/docs/sigma-product-releases) + +If something doesn’t work as expected, here's how to [contact Sigma support](https://help.sigmacomputing.com/docs/sigma-support) + +### Target Audience +Developers who want to use Sigma's REST API to programmatically control Sigma in an embedded context. + +### Prerequisites + + + + + +
+ + + + + +![Footer](assets/sigma_footer.png) + +## Start the Server +Duration: 5 + +Start the Express server in terminal from the `embedding_qs_series_2_api_use_cases` folder and enable debugging: +```code +DEBUG=true npm start +``` + +The server is ready when it displays: `Server listening at http://localhost:3000`. + +Browse to the landing page: +```code +http://localhost:3000 +``` + +Select the `Exports` page and click `Go`. + +Select the `Embed_API_QuickStart` workbook: + + + + + +The embed loads but there are no exports set up yet, and we can only see the `Schedule Export` button. + +![Footer](assets/sigma_footer.png) + + +## Schedule an Export +Duration: 5 + +Click the `Schedule Export` button to access the modal. + +Configure it to send a `PDF` daily at 9:00 AM to a valid email address: + + + +Click `Create`. + +Observing the console log, we can see the `POST` command to Sigma along with the various path and body parameters sent. For example, we set the `includeLink` value to `false` since this is an embed and we don't want embed users to have that link back to Sigma in the email: + + + +A popup will confirm the export was created with `Export schedule created successfully!`. + +Click `Ok` to close that. + +We are returned to the page and now there is a `Manage Exports` button present. This appears whenever the selected workbook has a export schedule: + + + +Before we look at that, let's confirm in Sigma that the export job has been created there. + +Open Sigma and navigate to the `Embed_API_QuickStart`. + +Select `Scheduled Exports` from the workbook's menu: + + + +We will have the job just created listed: + + + +![Footer](assets/sigma_footer.png) + + +## Manage Exports +Duration: 5 + +Back in our host application, click the `Manage Exports` button. + +For each export job, we provide three functions: + + + +They are self-explanatory; go ahead and experiment with them to see how they work, observing the console and browser inspection logs for each operation. + +For example, if we click, `Run Now`, we are prompted for one or more email addresses to send to. we are asked to confirm and then we verify the email arrived in our mailbox: + + + +### Cleanup +You may want to delete any export jobs created so that they do not run on future schedules. Just click the `Delete` button for each job created. + +Once all are deleted, the `Manage Exports` button will be hidden. + +![Footer](assets/sigma_footer.png) + + +## What we've covered +Duration: 5 + +In this QuickStart, we demonstrated how to extend your Sigma embedding experience with export management functionality. Specifically, we covered: + +- Creating scheduled export configurations with custom recipients, subjects, messages, and delivery formats (PDF, CSV, Excel). +- Setting up automated delivery schedules with daily, weekly, or monthly frequency options and custom timing. +- Managing existing export schedules through a dedicated interface that allows viewing, editing, and deleting configurations. +- Implementing immediate export delivery using saved schedule configurations with custom recipient targeting. +- Integrating export functionality seamlessly with embedded workbook selection and preview capabilities. + +This QuickStart builds on the foundational embedding setup and introduces a practical use case for email-based content sharing directly from the embedded environment, eliminating the need for users to access the Sigma interface directly. + +**Additional Resource Links** + +[Blog](https://www.sigmacomputing.com/blog/)
+[Community](https://community.sigmacomputing.com/)
+[Help Center](https://help.sigmacomputing.com/hc/en-us)
+[QuickStarts](https://quickstarts.sigmacomputing.com/)
+ +Be sure to check out all the latest developments at [Sigma's First Friday Feature page!](https://quickstarts.sigmacomputing.com/firstfridayfeatures/) +
+ +[](https://twitter.com/sigmacomputing)  +[](https://www.linkedin.com/company/sigmacomputing)  +[](https://www.facebook.com/sigmacomputing) + +![Footer](assets/sigma_footer.png) + +