Connecting Bold BI to FreshworkCRM data source

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

Choose FreshworkCRM data source

To configure the FreshworkCRM 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 FreshworkCRM 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 FreshworkCRM data source

Once you clicked the data source, the NEW DATA SOURCE configuration panel opens. Follow these steps to create a FreshworkCRM data source.

Enter a name and description (optional) for the data source.
Enter your FreshworkCRM hostname
Click the Api EndPoints dropdown box and choose the required endpoint.
Click the Custom Url if you want to enter the URL manually. Refer to the FreshworkCRM API documentation for more details.
Select the 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 FreshworkCRM data source. This value is used to fetch the data from the FreshworkCRM data source via pagination.
Choose a time interval using the Refresh Settings button to trigger the Rest API request periodically to keep the data in sync with our dashboard.
Select the JSON data type in the Data Format combo box.
Replace <:yourapitoken> under Headers with a valid API token.
Choose None under Authentication Type as authentication is done through header.

Choose data source

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

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

Login to your FreshworkCRM account. Go to Account -> Settings.
In Personal setting page click API settings tab.
You can find your API key in the field Your API key.
Use this API Key as <:yourapitoken> in the FreshworkCRM data source in the Bold BI Dashboard.

Reveal API Token

Additional information

Max Rows	Most of the REST APIs return only fewer data on a single API request. To pull the amount of data you need, set a value in this field. Pagination is handled internally and will fetch the amount of data you need.
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.

Setting up the URL

Replace <:your_domain> with your FreshworkCRM domain.

https://your_domain.freshsales.io/leads/view/8000328940

Sample endpoints

Contacts

https://your-domain.freshsales.io/api/contacts/view/8000666352

Deals

https://your-domain.freshsales.io/api/deals/view/8000666352

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 the JSON data retrieved from the FreshworkCRM Rest API request. This dialog displays a list of schemas in a treeview and their corresponding values in a grid for preview. Select required schema(s) from a 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.