Connecting Bold BI to Copper data source

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

Choose Copper data source

To configure the Copper 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 Copper 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

Create Copper data source

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

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

Example: https://api.prosperworks.com/developer_api/v1/leads/search
Select POST method for the REST API in Method combo box.
Select either Parameter(s) or Raw under Request Body. Set page_size as key and set your page size value.
Set values for Headers section like below key-value pairs:
Choose a time interval for the Refresh Settings using the combo box, to periodically trigger the REST API request and keep the data in sync with our dashboard.
Select JSON data type in Data Format combo box.
Choose None under Authentication Type.

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

How do I get API Key for connecting Copper data source?

Login to Copper account. Go to Settings -> API Keys.
Use this API key as value for X-PW-AccessToken in Copper data source in Bold BI Dashboard.

Additional information

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

For instance, to get the specific task details, query the /tasks/search endpoint.
From the listed information get the ID of the specific task.

NOTE: To get the specific task detail, set the Method Type as GET. Set Method Type based on endpoint.

Replace it in the URL to query a particular payment:

https://api.prosperworks.com/developer_api/v1/tasks/<:task_id>

Sample queries

List Contact Types

https://api.prosperworks.com/developer_api/v1/contact_types

List Lead Statuses

https://api.prosperworks.com/developer_api/v1/lead_statuses

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 Copper Rest API request. This dialog displays a list of schemas in a 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 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 in the data source connection. You can now connect to the data source using custom attributes or dashboard parameters.

Custom Attribute

Custom