Search results

Connecting Bold BI to Copper data source

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

Choose Copper data source

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

  1. Click the Data Sources button 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 Copper 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 Copper data source

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

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

  2. Enter a valid Copper REST API endpoint in the URL textbox. Refer the Copper API documentation for more details.

    Example: https://api.prosperworks.com/developer_api/v1/leads/search

  3. Select POST method for the REST API in Method combo box.

  4. Select either Parameter(s) or Raw under Request Body. Set page_size as key and set your page size value.

  5. Set values for Headers section like below key-value pairs:

    Headers

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

  7. Select JSON data type in Data Format combo box.

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

  1. Login to Copper account. Go to Settings -> API Keys.

  2. Use this API key as value for X-PW-AccessToken in Copper data source in Bold BI Dashboard.

    Reveal API Key

Additional information

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. If you do not want to sync your new data, choose ‘Never’.

Setting up the URL

  1. For instance, to get the specific task details, query the /tasks/search endpoint.
  2. 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/developerapi/v1/tasks/<:taskid>

Sample queries

List Contact Types

https://api.prosperworks.com/developerapi/v1/contacttypes

List Lead Statuses

https://api.prosperworks.com/developerapi/v1/leadstatuses

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 JSON data retrieved from Copper 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.

    Preview

  • 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

Copper Rate Limits

Copper Integration