Search results

Connecting Bold BI to BoldDesk data source

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

Choose BoldDesk data source

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

  1. Click the Data Sources option in the configuration panel to add a new data connection.

    Data source icon

  2. Click CREATE NEW to launch a new connection from the connection panel.

  3. Select the BoldDesk connection in the connection panel.

    Choose data source

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 BoldDesk data source

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

  1. Enter a name and description (optional) for the data source.

  2. Enter the HostName for the connected account.

  3. Enter your x-api-key in API Key text box for the connected account. Refer to BoldDesk Document-Authentication for more details.

  4. Click the API Endpoints dropdown box and choose the required endpoint.

  5. Click the Custom URL to enter the URL manually. Refer to BoldDesk API documentation for more details.

  6. Select GET method for the REST API in Method combo box.

  7. In Max Rows, enter the maximum number of rows to be fetched from the BoldDesk data source. This value is used to fetch the data from the BoldDesk data source using the pagination.

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

  9. Choose None in the Authentication Type combo box.


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

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


Dashboard Parameter

Dashboard Parameter

Note: Refer the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.

Additional information

Max Rows Most 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 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

  1. For entering the URL manually, click the Custom URL, then enter the URL. Refer to the BoldDesk API documentation for more details.

  2. For instance, if you need to get the specific ticket, you need to replace your Ticket Id in the following API in Custom URL.

  3. Replace it in the URL to query a particular conversations:


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

Sample queries

Get all Brands


Get Contact by Id


Data Refresh Modes

Full refresh During full refresh, all the data will be pulled for the selected BoldDesk resource and replaces the existing dataset completely.
Incremental refresh During incremental refresh, only the updated data alone will be pulled for the selected BoldDesk resource and appended or updated into the existing dataset. So, the refresh will be faster and consume less memory than the Full refresh.

Not all BoldDesk resources supports Incremental refresh, only following resources works on Incremental refresh.

Resource URL Incremental identifier columns
All Tickets https://your-domain/api/v1/tickets ticketId, lastUpdatedOn
All Contact https://your-domain/api/v1/contacts userId, lastModifiedOn
All Contact Groups https://your-domain/api/v1/contact_groups contactGroupId, lastModifiedOn
All Linked Items https://your-domain/api/v1/integrations/linkeditems ticketId, updatedOn

NOTE: If the incremental identifier columns are not included in data sources, then it cannot process incremental refresh, so full refresh happens at that time.


Preview and data import

  • Click Preview & Connect to connect with the configurations set.

  • The Choose Table(s) dialog opens. The schema represents the key fields of JSON data retrieved from BoldDesk 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. Query Editor

  • Click Save to save the data source with a relevant name.

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

BoldDesk API Limits