diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/1.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/1.png new file mode 100644 index 00000000..726cde47 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/1.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/10.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/10.png new file mode 100644 index 00000000..a88d5d8b Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/10.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/2.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/2.png new file mode 100644 index 00000000..7087109c Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/2.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/3.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/3.png new file mode 100644 index 00000000..aae562bf Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/3.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/4.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/4.png new file mode 100644 index 00000000..85d1e24d Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/4.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/5.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/5.png new file mode 100644 index 00000000..ce0d7728 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/5.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/6.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/6.png new file mode 100644 index 00000000..b7b3cd01 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/6.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/7.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/7.png new file mode 100644 index 00000000..b053ded8 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/7.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/8.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/8.png new file mode 100644 index 00000000..3cf0e617 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/8.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/9.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/9.png new file mode 100644 index 00000000..3aff50c3 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/9.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_01.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_01.png new file mode 100644 index 00000000..f2ed30dd Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_01.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_02.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_02.png new file mode 100644 index 00000000..399a1bad Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_02.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_03.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_03.png new file mode 100644 index 00000000..9464302b Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_03.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_04.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_04.png new file mode 100644 index 00000000..ff9874a9 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_04.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_05.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_05.png new file mode 100644 index 00000000..2d62125f Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_05.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_06.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_06.png new file mode 100644 index 00000000..291458e5 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_06.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_07.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_07.png new file mode 100644 index 00000000..f8487940 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_07.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_08.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_08.png new file mode 100644 index 00000000..b84c92cd Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_08.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_09.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_09.png new file mode 100644 index 00000000..d40141ca Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_09.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_10.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_10.png new file mode 100644 index 00000000..d65c5cec Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_10.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_11.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_11.png new file mode 100644 index 00000000..b3af045f Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_11.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_12.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_12.png new file mode 100644 index 00000000..e835cedf Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_12.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_13.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_13.png new file mode 100644 index 00000000..9fbb6fc4 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/api_actions_gs_13.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/caret.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/caret.png new file mode 100644 index 00000000..13a132ab Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/caret.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/closeview.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/closeview.png new file mode 100644 index 00000000..d0fbb0e4 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/closeview.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/crane.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/crane.png new file mode 100644 index 00000000..225ecf3f Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/crane.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/facebook.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/facebook.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/greencheckbox.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/heart_icon.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/heart_icon.png new file mode 100644 index 00000000..bff9ea90 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/heart_icon.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/horizonalline.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/linkedin.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/linkedin.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/sigma_footer.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/twitter.png b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/dataapps_api_actions_getting_started/assets/twitter.png differ diff --git a/site/sigmaguides/src/dataapps_api_actions_getting_started/dataapps_api_actions_getting_started.md b/site/sigmaguides/src/dataapps_api_actions_getting_started/dataapps_api_actions_getting_started.md new file mode 100644 index 00000000..22eb29fe --- /dev/null +++ b/site/sigmaguides/src/dataapps_api_actions_getting_started/dataapps_api_actions_getting_started.md @@ -0,0 +1,276 @@ +author: pballai +id: dataapps_api_actions_getting_started +summary: dataapps_api_actions_getting_started +categories: dataapps +environments: web +status: hidden +feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues +tags: +lastUpdated: 2025-11-11 + +# API Actions - Getting Started + +## Overview +Duration: 5 + +This QuickStart introduces Sigma API Actions by connecting to the Open-Meteo Weather API, a free weather data service that requires no authentication. + +You'll use a preconfigured Sigma template to select a city from a dropdown list and fetch current weather details in real-time. + +Along the way you'll learn how to: +- configure API connectors with both static and dynamic parameters +- bind dropdown controls to drive Action inputs +- parse and map JSON responses for analysis and visualization + + + +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 +The typical audience for this QuickStart includes users of Excel, common Business Intelligence or Reporting tools, and semi-technical users who want to try out or learn Sigma. + +### Prerequisites + + + + + + + + + +![Footer](assets/sigma_footer.png) + +## Initial Setup +Duration: 5 + +### Open-Meteo Weather API Account +While there are services that require credentials, we want to demonstrate using one that requires credentials, as that is a simple first example. + +We will use the [Open-Meteo API](https://open-meteo.com/) in this QuickStart. + + + + + +### API Connectors +API Connectors in Sigma define the endpoint that will be called by our Sigma workbook actions. Given that, it makes sense to first configure the endpoint we want to call and then we can configure an action to request data from it. + +Log into Sigma as an administrator and navigate to `Administration` > `API connectors` and click `Create connector`. + +We will configure a simple example to request weather data with the location and temperature format hard-coded. + +**Name:** The name of the connector as it appears to users in a workbook.
+Use this name: +```code +Current Temp - Hard Coded +``` + +**Description:** [optional] A custom description that helps users identify the connector and verify its contents. + +**Base URL:** Select an HTTP method and the URL for the request.
+Use this URL: +```code +https://api.open-meteo.com/v1/forecast?latitude=20.7702&longitude=-156.2682&timezone=auto&temperature_unit=fahrenheit +``` + +**Headers:** [optional] Set a header for the request. +None required. + +**Params:** [optional] Set query and path parameters for the request. To set path parameters, you must include /:param in the Base URL. You can then select whether to populate the path param with Static or Dynamic values.
+None required. + +**Body:** [optional] Enter a request body.
+None required. + +Farther down we can see a preview of the endpoint and credentials settings (No authentication is required for this API): + + + +**Credentials:** [optional] Select a credential from your configured API credentials in Sigma.
+None required. + +For more information, see [Add a new API credential to Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma#grant-access-to-api-credentials-and-connectors) + +Since no authentication is required, we can just copy and paste the preview URL into another tool like [Postman](https://quickstarts.sigmacomputing.com/guide/sigma_api_with_postman/index.html?index=..%2F..index#0) to see if we get the expected response. + +For example, a quick test in Postman to check the response: + + + +Click `Save`. + +### Sigma template - PENDING! +To make this process easier, we have created a [template](https://help.sigmacomputing.com/docs/create-and-edit-workbook-templates) that is preconfigured. + +Return to the Sigma homepage and click `Templates`. Click to select the `API Actions Getting Started QuickStart` template: + + + +This creates a new (unsaved) workbook we can use and the first thing we want to do is save it as `API Actions Getting Started QuickStart` + + + +![Footer](assets/sigma_footer.png) + + +## GET a Response +Duration: 5 + +With the Sigma `API Actions Getting Started QuickStart` workbook we can just click on the `Click me` button to see the raw response from Open-Metro: + + + +Selecting the button, we can see how the `Call API` action is configured to call our `Current Temp - Hard Coded` API connector: + + + +The action above this one clears the `Raw Response` text area control out first and the control after it, places the response data into the text area control: + + + + +![Footer](assets/sigma_footer.png) + + +## Parse a Response +Duration: 5 + +Now that we see how to get data, we need to format the data so that we can reliably read values from it. + +Since the data is raw, we can easily convert it to JSON using a formula. Let's use a KPI chart to show the current temperature from the raw response. + +On the `Parse Temperature` page we have the same `Click Me` button and a pre-configured KPI chart. The button actions are the same as before. + +If we look at the KPI properties panel, we see that it is bound to the `Cities` table on the `Data` page. + +Before this will work, we need to convert the raw response to JSON by adding a column to the KPI using the [Json](https://help.sigmacomputing.com/docs/json) conversion function: +```code +Json([Raw-Response]) +``` + + + +Once converted, we can parse the temperature from the JSON +```code +Number([Raw-Response].current_weather.temperature) +``` + + + +Clicking the button displays the current temperature for our hard-coded location. + +![Footer](assets/sigma_footer.png) + + + +## Dynamic Query Parameters +Duration: 5 + +In the last section we used the City table. This table on the `Data` page populates a dropdown control, allowing users to select which city's current temperature to retrieve. + +Return to `Administration` > `API Connectors` and add a new one. + +**Name:** Current Temp - City Select + +**Base URL:** Select an HTTP method and the URL for the request.
+Use this URL: +```code +https://api.open-meteo.com/v1/forecast?latitude={{latitude}}&longitude={{longitude}}¤t_weather=true&temperature_unit=fahrenheit +``` + + + +**Params:** Add four query parameters: +```code +KEY TYPE VALUE +latitude Dynamic +longitude Dynamic +current_weather Static true +temperature_unit Static fahrenheit +``` + + + +Also check the endpont preview (at the bottom of the page) carefully. Small mistakes will cause API call failures: + + + + +### Testing +Return to the `API Actions - Getting Started QuickStart` workbook and the `City Temp` page. + +The three text controls are showing `Multiple values`. We left if this way to make it clear that the data coming from the `Data` page > `Cities` table which currently showing all rows. + +The `Store Name` input select control above these values is not yet set to a single store. Therefore, `Multiple values`. We don't need to correct that, we just wanted it to be clear where the data is coming from. + +The temperature KPI is also parsing the data from the previous request, which still has response data on the `Raw Response` page. + +Select a store location to see it work: + + + +With the `Store Name` control selected, we can see the `Call API` action is configured to send latitude and logitude from columns in the `Cities` table: + + + +Really simple and crazy powerful too! + +### Data types +Anyone who has worked with APIs will know that data type match matters. No different here; we needed to convert the `Latitude` and `Longitude` columns in the `Cities` table from number to [Text](https://help.sigmacomputing.com/docs/text) using a built-in Sigma function. + + + +If we did not do this, Open-Meteo's API would send an error in the response and often API errors are not all that helpful. + +![Footer](assets/sigma_footer.png) + + +## What we've covered +Duration: 5 + +In this QuickStart, we explored the fundamentals of Sigma API Actions by building a simple weather data application. You learned how to: + +- Configure API connectors with both static and dynamic parameters +- Create actions that call external APIs from Sigma workbooks +- Parse JSON responses using Sigma's built-in functions +- Build interactive experiences using controls to drive API inputs +- Handle data type conversions for API compatibility + +These techniques form the foundation for integrating any REST API into your Sigma workbooks, enabling you to combine cloud data warehouse analytics with real-time external data sources. + +**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) + +