Connecting Bold BI to GoSquared data source

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

Choose GoSquared data source

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

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

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

Example: https://api.gosquared.com/now/v3/overview?api_key=<:your_api_key>&site_token=<:your_site_token>
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. This value is used to fetch the data via pagination.
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 and Site Token for connecting GoSquared data source?

Log in to your GoSquared account.
To obtain the Site Token, Go to Settings -> Current Project -> General -> Project Token.
Use this Project Token as the Site Token in the GoSquared data source in the Bold BI dashboard.
To get API Key, Go to Settings -> Your account -> API Access.
If you already have an API Key, use it as the API key as API Key in the GoSquared data source in the Bold BI dashboard.
If an API key is not available, generate a new API Key by clicking on Add new 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'.

Setting up the URL

For instance, to retrieve the, list of online visitors from different countries, replace the api_key and site_token like in the below URL to query countries list.

https://api.gosquared.com/now/v3/countries?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B

NOTE: Add additional parameters in URL based on endpoint to summarize data based on date (e.g.start/from, to). Refer GoSquared Documentation.

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

Sample queries

List of currently running Campaigns

https://api.gosquared.com/now/v3/campaigns?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B

List of Online Visitors

https://api.gosquared.com/now/v3/visitors?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B

List of Browsers on which Online Visitors use for browsing

https://api.gosquared.com/now/v3/browsers?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B

List of summary about the browser metrics over a given period

https://api.gosquared.com/trends/v2/browser?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B

Combining Functions

https://api.gosquared.com/now/v3/timeSeries:1,timeSeries:2,concurrents?api_key=JSOjsiw92he83h42HWj&site_token=GSN-763262983-B&timeSeries:1:from=2015-09-01&timeSeries:1:to=2015-09-07&timeSeries:2:from=2015-10-01&timeSeries:2:to=2015-10-07

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