Connecting Bold BI to Recurly data source

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

Choose Recurly data source

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

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

Enter a name and description (optional) for the data source.
Click the API Endpoints down drop box and choose the required endpoint.
Click the Custom Url to enter the URL manually. Refer to the Recurly 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 Recurly data source.
Choose a time interval for the Refresh Settings using the combo box, to trigger the Rest API request periodically to keep the data in sync with our dashboard.
Select the XML data type in the Data Format combo box.
Choose the Basic HTTP Authentication under the Authentication Type.
Enter a valid the Account Key to access the endpoints in your account.

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

How do I get Account Key for connecting Recurly data source?

Login to your Recurly account. Go to Admin -> Users -> Configure API Access.
Use this Private API Key as the Account Key in the Recurly data source in the Bold BI Dashboard.

Reveal API Key

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

Sample queries

Accounts

https://myaccount.recurly.com/v2/accounts

Invoices

https://myaccount.recurly.com/v2/invoices

Plans

https://myaccount.recurly.com/v2/plans

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 Recurly 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