The Bold BI dashboard designer supports connecting to Kissmetrics web services through the REST API.
To configure the Kissmetrics 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 Kissmetrics 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.
Once you click on the data source, the NEW DATA SOURCE configuration panel will open. Follow the below steps to create Kissmetrics data source.
Enter a name and description (optional) for the data source.
Enter a valid Kissmetrics REST API endpoint in the URL textbox. Refer to the Kissmetrics API documentation for more details.
Example: https://query.kissmetrics.com/v3/products/{product_id}/reports
Select the GET method for the REST API in the Method combo box.
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 Basic HTTP Authentication in Authentication Type combo box.
Enter the valid credentials associated with your account in Username & Password text boxes.
You can also edit the connection information set here using the Edit Connection option.
Max Rows | Most REST APIs return only a limited amount of data on a single API request. To retrieve the necessary amount of data, you can set a value in this field. Pagination is handled internally and will fetch the required data. |
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'. |
Replace it in the URL to query a particular reports: https://query.kissmetrics.io/v3/products/{product_id}/reports
.
For more information on the API endpoints available for this data source, refer to their official API Documentation
Properties
https://query.kissmetrics.com/v3/products/{product_id}/properties
Events
https://query.kissmetrics.io/v3/products/{product_id}/events
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 Kissmetrics 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.
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
Dashboard Parameter
Note: Refer to the Dashboard Parameter Documentation and Custom Attributes Documentation for more details.