Connecting Bold BI to Web data source

The Bold BI dashboard designer supports connecting to nearly all web services that have a REST API interface. A live connection in Bold BI is more powerful than an extract connection because it does not store data in the data process. However, it is different from Direct Query since it fetches the data from your server rather than connecting directly to it.

What is Live Connection?

A live connection feature is available for WEB API data sources. Live web API connections do not store data in the data process. The fetched data will be cleared from the data process once all widgets have been visualized in the dashboard.

Advantages

1. Dashboard can automatically update with live data.
2. Data will no longer be stored on the data process, making it more secure.
3. There is no need to configure refresh settings for data refresh.
4. Shared and Joined more than one live data sources.
5. The Dashboard parameter is supported in Live connection, allowing for a global placeholder value such as a number, string, or date.
6. Pick up a selected column from the Web API schema.

Limitations

Some of the limitations associated with the Bold BI Web API LIVE Connection are as follows:

1. For optimum performance in live mode Web API, records are restricted to 5000 by default. Use the Extract mode for more than 5000 records. Change the limit from the Max Rows option to fetch more records.
2. It is a bit slower than the extract mode connection because the data will be fetched from your server for every action.

Workflow of live connections in Bold BI

1. In the beginning, the Live Web API can fetch data from a connected server and transfer it to a connected data processing unit.
2. Widgets on the dashboard are displayed based on the fetched data.
3. The data will be cleared from the data processing unit once the dashboard data has been displayed.

Choose web data source

To configure the web data source, follow the below steps:

1. Click the Data Sources button in the configuration panel to add a new data connection.

   

2. Click CREATE NEW to launch a new connection from the connection panel.

3. Select the Web connection in the connection panel.

   

NOTE: You can also create a data source from the home page by clicking on the Data Sources menu on the left menu panel and selecting Create Data Source from the data sources page.

Create web data source

After clicking on the data source, the NEW DATA SOURCE configuration panel will open. Follow the below steps to create web data source:

1. Enter a name and description (optional) for the data source.

2. Enter a valid REST API endpoint in the URL text box.

3. Choose one of the Method Type from the combo box for the provided REST API. The options are GET and POST.

4. If required by the REST API, provide key value pairs in Headers. For details about headers, refer to Query Parameters.

5. Choose a time interval for Refresh Settings using the combo box to trigger the Rest API request periodically to keep the data in sync with our dashboard.

6. Choose a Data Format from the combo box based on the response of your provided REST API. The options are JSON, CSV, and XML.

7. Choose an Authentication Type supported by the data source. The options are Basic http authentication and None. Learn more about Authentication Types.

8. Choose a Pagination Type supported by the data source from the combo box.

   

You can also edit the connection information set here using the Edit Connection option.

Preview and Data Import

• Click Preview & Connect to connect with the configurations that have been set.

• The Choose Table(s) dialog opens. The schema represents the key data fields retrieved from the Web Rest API request. This dialog displays a list of schemas in treeview and their corresponding values in the grid for preview. Select the required schema(s) from the treeview to use in the designer and click Connect.

  

• Now, the data design view page with the selected table schema opens. Drag and drop the table.

  

• Click Save to save the data source with a relevant name.

Connect using custom attribute and dashboard parameter

We have added support for custom attributes and dashboard parameters in the data source connection. You can now connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Dashboard Parameter

Note: Refer to the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.

Pagination Types

Options are None, Offset, Next Page, Next Token, and Next URL.

Note: According to the pagination type, the response data must align with the provided JSON format.

None

It can be used when the REST API does not need to be paginated. This will return only the first set of records.

Offset

The number of records that should be skipped before beginning pagination.

For example, connect the OData REST API in the web data source with the pagination parameters as shown below:

Sample for total records

Sample for data indicator path

Next Page

The number of pages that need to be fetched with the specific number of records per page.

For example, connect the Smartsheet REST API in the web data source with the pagination parameters as follows:

Sample for total pages

Sample for data indicator path

Next Token

Iterate the next set of records using a token.

For example, let’s connect the Google AdSense REST API in the web data source with the pagination parameters as follows:

Sample response

Next URL

Iterate the next set of records using url obtained from the response.

For example, let’s connect the GitHub REST API in the web data source with the pagination parameters as follows:

NOTE: To implement pagination, you must provide either the Total Records Path or the Data Indicator Path. If both values are provided, the Total Records Path will take precedence.

Query Parameters

1. If the Rest API requires it, pass the necessary values as key-value pairs in the Headers.
2. For the POST method, if necessary, pass the required values as key-value pairs in the Parameters.
3. Use either Parameter(s) or Raw for a POST request.

Authentication Types

1. If your data source supports authentication directly through the REST API URL, choose None under Authentication Type.
2. If your data source supports API Key/API Token authentication, pass these values under Header(s) by clicking +Add. Choose None under Authentication Type.
3. If your data source has Basic HTTP authentication, choose Basic http Authentication under Authentication Type and input the username and password.

Connecting Web API data source with API Key Authentication

An API key is one of the most commonly used authentication types for REST APIs. The API key will be assigned to a user by the provider at the time of user creation or when enabling API key authentication to access data via the REST API.

API keys can be used in the following places, which are listed below.

• Authorization/Custom Header (Basic or Bearer).
• Query String.
• Body Data.

Adding Authorization/Custom header for API Key

To connect a REST API for adding an API Key in the header, you can follow the steps below to connect the API in Bold BI.

• Add header in Web API data source as below.

  

• You need to select the Authentication Type as None.

  

• The header value can be either basic or bearer, depending on the application to which you are connecting.

• Most API Key authentication methods connect using the Authorization header. You can also change the name of the header key as needed.

  

Adding API Key in Query String Parameter

A query string parameter will be added to the URL, allowing you to access the REST API without the need to add any headers or bodies.

• No additional steps may be required for connecting to the API using Query String type of API Key authentication.

• You need to select the Authentication Type as None, since the API Key is added in the Query String parameter.

  

Adding API Key in the Body Data for Post method REST APIs

Body data is typically added for POST method API calls. If the application is designed to send the API Key over the body data of the REST API, you can follow the steps below.

• Please select the POST method in the Web API data source to include Body Data and then add the API Key as shown below, using the appropriate property names.

  

• You need to select the Authentication Type as None since its API Key is added as Body Data.

  

Connecting Bold BI to WEB Live Data Source via REST API

Prerequisites

Type while creating the data source needs to be Web.

Rest API - v4.0

Modes

Only the Live mode WEB data source can be created through the REST API.

Parameters for creating Data Source

For creating connection:

{
 "Name": "string",
 "Type": "Web",
 "Connection": {
   "Url": "string",
   "MethodType": "string",
   "DataFormat": "string",
   "Headers":[],
   "AuthenticationType": "string",
   "RefreshInterval": "string",
   "Provider": "WEB",
   "ProviderType": "Web",
   "Rows": "string",
   "Mode": "Live",
   "DataProvider": "WEB"
 }
}

For creating a connection with Headers, Parameters, Raw Body, and Authentication:

{
 "Name": "string",
 "Type": "Web",
 "Connection": {
   "Url": "string",
   "MethodType": "string",
   "DataFormat": "string",
   "Headers": [
     {
       "key": "string",
       "value": "string"
     }
   ],
   "Parameters": [
     {
       "key": "string",
       "value": "string"
     }
   ],
   "RawData": "",
   "AuthenticationType": "string",
   "Username": "string",
   "Password": "string",
   "RefreshInterval": "Never",
   "Provider": "WEB",
   "ProviderType": "Web",
   "Rows": "string",
   "Mode": "Live",
   "DataProvider": "WEB"
 }
}

Dashboard Parameter

Utilize dashboard parameters in conjunction with a Live Web API connection. Connecting to the Web API live connection, along with using dashboard parameters, will assist in achieving various use cases. Below are some examples of using dashboard parameters with Live web connections.

Dashboard parameters can be used in the Web API connection’s URL, Headers, and Parameters.

Example 1: Filtering the dashboards based on Literal Mode.

Follow these steps to use the feature.

1. Connect the REST API to the live web data source.

https://services.odata.org/V4/OData/OData.svc/Products 2. Once you have connected the data source, create the StartDate and EndDate under the Literal Mode dashboard parameters. 3. Save the data source first. Then, click on the Edit Data Source button to reconnect the dashboard parameter URL provided, and save the changes. Example:http://services.odata.org/V4/OData/OData.svc/Products?%24filter=ReleaseDate%20gt%20@{{:LiteralDS.StartDate}}T00:00:00Z%20and%20ReleaseDate%20lt%20@{{:LiteralDS.EndDate}}T00:00:00Z

4. Create the dashboard using the data source and then publish it.

>  **NOTE:** A dashboard is rendered according to the date range configured in the dashboard parameter when the data source is created.

5. Click on the dashboard parameter icon and adjust the date range to display the dashboard with the specified values. 6. Real-time data will be displayed on the dashboard according to the chosen date range.

Example 2: Filtering the dashboards based on Iterative Mode.

Note: The Live Web data sources do not support multiple iterative modes for optimal performance and minimal time delay.

Follow these steps to use the feature.

1. Connect the REST API to the live web data source.

https://gorest.co.in/public/v2/users

2. Once you have connected the data source, create the User ID under the Iterative Mode of the dashboard parameters. Refer to the document for instructions on how to add the Iterative Mode dashboard parameter.

3. Save the data source. Then, click edit data source to reconnect the dashboard parameter URL as provided and save the changes. Example:https://gorest.co.in/public/v2/users/@{{:IterativeDS.User ID}}

4. Create the dashboard with the data source and publish it.

   NOTE: A dashboard is rendered according to the range of User IDs configured in the dashboard parameter when the data source is created.

   

5. Click on the dashboard parameter icon and select the User IDs to render the dashboard with the specified values.

6. Real-time data will be displayed on the dashboard based on the selected User ID’s range.

Limitation Information

Configuring Date Parameters

You can configure the URL of the API request with templates containing date queries. The queries will be updated with the respective date values.

Syntax{{:today()}}:It is used for single calendar related method.

Or

Syntax{{:today().adddays(1)}}:It is used when more than one method is added.

For example,a dummy API is used to explain here

Now, this URL will be parsed, and templates will be matched. Therefore, the templates will be replaced with dates accordingly. This will help you fetch data between the start date and end date.

Functions supported in date parameters

You can configure parameters as numeric values for the following functions: AddMinutes, AddHours, AddDays, AddWeeks, AddMonths, AddYears, AddQuarters, SetDayStart, and SetMonthStart.

All the Add methods should not have a parameter of 0. The SetDayStart function should have a numerical value between 0 and 6, and the SetMonthStart function should have a numerical value between 1 and 12.

String parameters are utilized in the following set of functions: start, end, format, and SetTimeZone. Both the start and end functions support four string parameters - week, month, quarter, and year. The format function is utilized to modify the format of date and time, with the parameter aligning with the date and time format supported in C#. Additionally, support for epoch time is available in the format function. The SetTimeZone function is utilized to alter the time zone of the date, with the parameter aligning with TimeZoneInfo IDs present in C#.

Today function does not hold any parameters. Here for example concern we are using today()as 11/16/2018 12:17

NOTE: Each template should start with the today function as a mandatory requirement. If the format function is used in a template, it should be the last function call.

Related links

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough