Connecting Bold BI to Alchemer data source

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

Choose Alchemer data source

To choose an Alchemer data source, follow these 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 Alchemer connection in the connection panel.

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

Choose data source from server

Create Alchemer data source

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

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

Example: http://restapi.alchemer.com/v5/<:yourendpoint>?api_token=<:your_api_token>&api_token_secret=<:your_api_secret>
Select GET method for the REST API in the Method dropdown.
Enter the maximum number of rows to be fetched from the Alchemer data source in the Max Rows field for pagination.
Choose a time interval for Refresh Settings to trigger the REST API request periodically to keep the data in sync with the dashboard.
Select JSON data type in the Data Format dropdown.
Choose None for Authentication Type.

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

How do I get API Token for connecting Alchemer Data source?

Login to your Alchemer and go to Account -> Integrations -> API Key to get your API key and API secret.
If you don’t have any keys, go to Account -> Integrations -> Manage API -> Create an API key to generate a new key.

Additional information

Max Rows	Most REST APIs return only a limited amount of data on a single API request. To retrieve the necessary amount of data, you can set a value in this field. Pagination is handled internally and will fetch the required data.
Refresh Settings	The period of time before the next refresh call is triggered. This will automatically trigger a call to 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’.

Setting up the URL

You can replace the API Key and API Secret in the URL field. Otherwise, replace the API Request Parameters in the URL instead of the default parameters in the URL field.

Sample queries

Surveys

http://restapi.alchemer.com/v5/survey?api_token=kjUnjee3njnWJOniO&api_token_secret=A9WHOxTYs

Preview and data import

Click Preview & Connect to connect with the configurations that have been set.
The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from the Alchemer Rest API request. This dialog displays a list of schemas in a treeview and its corresponding values in a 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 to the data source connection. You can connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Custom