How to use Iterative dashboard parameter in Bold BI?

Published:

Web APIs are a powerful tool for fetching data from a server. Sometimes you may need need to fetch data from list of APIs at a time for your Web API. For instance, you need retrieve a list of items that are specific to users with each user having an unique API parameter. This guide will walk you through the process.

Step 1: Create the Required Parameter

Before you start creating or editing a web data source, you need to create the required parameter on the existing data source. If you want to get data from multiple web APIs and merge their data into a single table using the dashboard parameter, please select the Iterative type when creating the dashboard parameter. This will create multiple web APIs and return their data into a single table.

Iterative parameters act as placeholders or variables that can update values dynamically. For more information on how to create iterative parameters, refer to the iterative parameter documentation here

Step 2: List the Dashboard Parameters

To list the dashboard parameters from the data sources that are added in your dashboard, simply type the ‘@’ symbol to populate the list of available parameters.

Step 3: Use the Dashboard Parameter in Your Web API

If the data source (which has the dashboard parameter) is not present in your dashboard or you are creating a data source from the data source listing page, you can use the dashboard parameter in your Web API wherever you want using the following syntax:

@{{:DataSourceName.ParameterName}}

Click connect to iterate the URL for all the available values in the mentioned parameters. For Example, if the parameter @{{:mydatasource.param1}} contains values 1,2,3, then the APIs will be iterated like below,

https://mysite.syncuser123/MockAPI/main/1
https://mysite.syncuser123/MockAPI/main/2
https://mysite.syncuser123/MockAPI/main/3

The resultant table will have value from all the iterated URL as shown below.