Connecting Bold BI to Zoho CRM data source

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

Choose Zoho CRM data source

To configure the Zoho CRM data source, follow the below steps:

Click on 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 Zoho CRM 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.

Choose data source from server

Authentication with Zoho CRM

Use the following steps to authenticate with the Zoho CRM web service:

Click on the data source, which will prompt a login window. Enter the credentials of your Zoho CRM account to authorize.
Click on Allow in the authorization window to accept the scopes requested by Bold BI dashboards.

NOTE: If permission is denied, the account will not be accessible from the dashboard.
Provide a name to identify the account and click Next.
You have now successfully authorized your connection. Click Connect to continue with the data source connection.
To connect via an already connected account, refer to Connected Accounts.

NOTE: To connect to another account, click Connect New Account.

Connect to Zoho CRM

Create Zoho CRM data source

After successful authentication, the NEW DATA SOURCE configuration panel will open. Follow the below steps to create Zoho CRM data source:

Enter a name and description (optional) for the data source.
Click the Endpoints dropdown and choose the required endpoint.
Click the custom URL if you want to enter the URL manually. Refer to the Zoho CRM API documentation for more details.

Example: https://www.zohoapis.com/crm/v2/<:your_end_point>
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 Zoho CRM data source. This value is used to fetch the data from the Zoho CRM data source via pagination.
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 the JSON data type in the Data Format combo box.
The authentication type will be set to Zoho CRM automatically since the OAuth is used for authenticating with the Zoho CRM account.

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

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

Setting up the URL

Fetch data about specific user - Sample URL

For example, to obtain the specific role details, query the /roles endpoint.
Retrieve the ID from the listed users’ information.

Replace the URL with the role ID to query a specific role.

https://www.zohoapis.com/crm/v2/settings/roles/<:role_id>

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

Sample queries

Users

https://www.zohoapis.com/crm/v2/users

Organizations

https://www.zohoapis.com/crm/v2/org

Leads

https://www.zohoapis.com/crm/v2/Leads

Preview and data import

Click Preview & Connect to connect with the configurations that have been set.
The Choose Schema(s) dialog will open. The schema represents the key fields of JSON data retrieved from the Zoho CRM Rest API request. This dialog displays a list of schemas in a treeview and their 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.

Connected accounts for OAuth data sources

If you have already logged into the account and authenticated with the web data source, the account information will be listed here. You can select one of the accounts or connect to a new account by clicking the Connect New Account button.

OAuth