Documentation
Demos
Support
Blog
Start Free Trial
Search results

Connecting Bold BI to Smartsheet data source

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

Choose Smartsheet data source

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

  1. Click on 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 Smartsheet connection in the connection panel.

    Choose data source

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

How to Obtain the Smartsheet Client ID and Client Secret

Note: Smartsheet OAuth credentials are required for the On-Premises Deployment but not needed in Syncfusion Managed Cloud Server.

  1. Go to the Smartsheet home page and log in to your account.
  2. Click the User icon and select Developer Tools from the menu.

Developertools

  1. Provide the necessary details and click Save to create your Developer profile.

Developerprofile

  1. On the Developer Tools menu, click the Create New App button to create a new app.

Createapp

  1. Enter the required details and the App redirect URL, then click the Save button. saveapp

NOTE: The Bold BI redirect URL should be added in the proper format. Please refer to this URL structure, https://hostname/bi/designer/v1.0/oauth/agent.

  1. The Client ID and Client Secret for your app will be displayed once the app is created. Appcredientals

NOTE: Save the client ID and client secret in Bold BI by following the OAuth Configuration guide for more details.

Authentication with Smartsheet

Use the following steps to authenticate with the Smartsheet web service.

  1. Click on the data source, which will prompt a login window. Enter the credentials of your Smartsheet account to authorize.

  2. Click on Allow in the authorization window to accept the scopes requested by Bold BI dashboards.

    NOTE: If permission is denied, the account will not be accessible from the dashboard.

  3. Provide a name to identify the account and click Next.

  4. You have now successfully authorized your connection. Click Connect to continue with the data source connection.

  5. To connect via an existing account, refer Connected Accounts.

NOTE: If you need to connect to another account click on Connect New Account.

Connect to Smartsheet

Create Smartsheet data source

After successful authentication, the NEW DATA SOURCE configuration panel will open. Follow the below steps to create Smartsheet data source.

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

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

    Example: https://api.smartsheet.com/2.0/sheets/<:sheet_id>/

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

  4. In Max Rows, enter the maximum number of rows to be fetched from the Smartsheet data source. This value is used to fetch the data from Smartsheet data source via pagination.

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

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

  7. The authentication type will be set to Smartsheet automatically since OAuth is used for authenticating with Smartsheet account.

    DataSourcesView

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

Additional information

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

Setting up the URL

  1. Login to Smartsheet. Open a sheet.

  2. Click File -> Properties to get the sheet id and sheet link.

    Sheet id

Replace it in the URL to query a particular sheet:

https://api.smartsheet.com/2.0/sheets/<:sheet_id>/

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

Sample queries

Reports

https://api.smartsheet.com/2.0/reports/Bi9c3AFP5Fx/

Sheet

https://api.smartsheet.com/2.0/sheets/1201906853930884/

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

    Preview

  • Now, the data design view page with the selected table schema opens. Drag and drop the table. Query Editor

  • Click Save to save the data source with a relevant name.

Connected accounts for OAuth data sources

If you have already logged into the account and authenticated with the web data source, the account information will be listed here. You can select one of the accounts or connect to a new account by clicking the Connect New Account button.

OAuth

You can edit, delete and re-authorize this account from the Connected Accounts page.

Manage Accounts

Data Transformation

Editing a Data Connection

Dashboard Designer Walkthrough

Smartsheet Integration

Previous
Next