Connecting Bold BI to ActiveCampaign data source

The Bold BI dashboard designer supports connecting to ActiveCampaign web services through the REST API.

Choose ActiveCampaign data source

To choose the ActiveCampaign data source, follow the steps below:

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 ActiveCampaign 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 from the data sources page.

Choose data source

Create ActiveCampaign data source

Once you click on the data source, the NEW DATA SOURCE configuration panel will open. Follow the steps below to create an ActiveCampaign data source:

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

Example: https://<your-account>.api-us1.com/api/3/connections
Select GET method for the REST API in the Method combo box.
In Max Rows, enter the maximum number of rows to be fetched from the ActiveCampaign data source. This value is used to fetch the data from ActiveCampaign data source via pagination.
Choose a time interval for Refresh Settings using the dropdown menu to periodically trigger the REST API request to keep the data in sync with the dashboard.
Select JSON data type in the Data Format dropdown menu.
Replace <:your_app_token> under Headers with a valid API key.
Choose None under Authentication Type, as authentication is done through the header.

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

How do I get API Key for connecting ActiveCampaign Data source?

Login to your ActiveCampaign account.
Go to Developer -> My Settings and get your API key

Reveal API 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’.
API Limits	ActiveCampaign API has a rate limit of 5 requests per second per account. Contact them for a custom rate limit solution.

Setting up the URL

Login to your account and get your Base URL on the My Settings page under the Developer tab.
Replace <:your-account> with this base URL.
Replace <:resource> with a valid endpoint.

https://<your-account>.api-us1.com/api/3/<:resource>

For more information on API endpoints available for this data source, refer to their official API Documentation

Sample queries

Campaigns

https://sample-user-api.com/api/3/campaigns

Deals

https://sample-user-api.com/api/3/deals

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 ActiveCampaign 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.

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