Connecting Bold BI to SparkPost data source

Bold BI dashboard designer supports connecting SparkPost web services through REST API.

Choose SparkPost data source

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

Click the Data Sources button in the configuration panel to add a new data connection.
Click CREATE NEW to launch a new connection from the connection panel.
Select the SparkPost connection in the connection panel.

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

Choose data source from server

Create SparkPost data source

Once you click the data source, the NEW DATA SOURCE configuration panel opens. Follow the below steps to create SparkPost data source.

Enter a name and description (optional) for the data source.
Enter a valid SparkPost REST API endpoint in the URL textbox. Refer the SparkPost API documentation for more details.

Example: https://api.sparkpost.com/api/v1/metrics
Select GET method for the REST API in Method combo box.
In Max Rows, enter the maximum number of rows to be fetched from the SparkPost data source.
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.
Select JSON data type in Data Format combo box.
Replace <yourapitoken> under Headers with a valid API token.
Choose None under Authentication Type as authentication is done through header.

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

How do I get API Token for connecting SparkPost data source?

Login to your account. Go to Settings -> API Keys.
Use this API Key as :yourapitoken in SparkPost data source in Bold BI Dashboard.

Reveal API Key

Additional information

Refresh Settings

Period of time before next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date. If you do not want to sync your new data, choose ‘Never’.

Sample queries

Events

https://api.sparkpost.com/api/v1/events/message

Templates

https://api.sparkpost.com/api/v1/templates

Suppression List

https://api.sparkpost.com/api/v1/suppression-list

Preview and data import

Click Preview & Connect to connect with the configurations set.
The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from SparkPost Rest API request. This dialog displays a list of schemas in treeview and its corresponding values in grid for preview. Select required schema(s) from treeview to use in designer and click Connect.
Now, the data design view page with selected table schema opens. Drag and drop the table.
Click Save to save the data source with a relevant name.