Home  >   Articles   >  Insights Designer

Insights Designer

This article guides you about creating an Insight page and pinning it to your Dashboard using Vtiger Insights Designer.
Abdul Sameer
4 Apr, 2024 - Updated 3 months ago
Table of Contents


If your data is voluminous and distributed across different apps, you need a tool that can pull, analyze, and present data in easy-to-understand charts and graphs.  

Vtiger Insights Designer helps you analyze vast amounts of data and build custom reports. The feature provides full control to CRM users to build specific BI reports suited to their needs. 

Application and Use Cases of Insights Designer
Using the Insights Designer, you can:

  • Create an Insight page with multiple report widgets
  • Fetch data from different endpoints. It supports the following queries
    • Vtiger Webservice query
    • Custom Rest APIs from Vtiger API Designer
  • Visualize and display data in various modes
    • Table
    • Pivot
    • Different types of charts
  • Pin the designed Insight (report) to the Dashboard
  • Share generated insights with other users

Insights Designer can be used in a wide range of industries. 

Following are a few use cases:

  • E-commerce: Insights Designer can help online retailers track and analyze customer behavior, such as browsing and purchasing habits, to optimize their website and product offerings.
  • Finance: Insights Designer can be used to analyze financial data, such as stock prices and market trends, to inform investment decisions and predict future market trends.
  • Healthcare: Insights Designer can help healthcare providers analyze patient data, such as medical histories and treatment outcomes, to improve patient care and treatment protocols.
  • Marketing: Insights Designer can help marketing teams analyze customer data to develop more targeted and effective marketing campaigns.
  • Supply Chain Management: Insights Designer can analyze supply chain operations data, such as inventory levels and shipping times, to optimize supply chain efficiency and reduce costs.
  • Social Media: Insights Designer can help social media managers track and analyze user engagement metrics, such as likes and shares, to inform content creation and marketing strategies.
  • Education: Insights Designer can be used to analyze student data, such as test scores and attendance records, to inform curriculum development and improve student outcomes.

Insights Designer Components

The following are the components available in the Insights Designer:

  • Insight - A record in the Insights Designer module is called an Insight.
  • Widget - Each report inside an Insight is called a Widget.
    • Input - Data sources that are used to fetch the data.
    • Transform - Ability to write javascript code to alter the data if needed.
    • Output - Where you can set up the output details for data visualization.

Let us learn more about these widgets.


This is where you can configure the input data source - from where data will be fetched. The Insight Designer supports multiple input types - Query, Webservice Query, and CSV.

Raw Query support is available on an on-demand basis only.

  • Query: If you want to fetch data directly from your instance Database, you can use this data source. When you select this source, the system gives you a Vtiger Query builder where you can fill in details to build the Query. After filling in the details, an estimated query will be shown at the bottom.

You can see Merge Fields on the right-hand side of Input. Those are the filters you enabled in Insight. You can use filters to add conditions to your insight. Clicking on the Merge Field will copy the merge tag to the clipboard. You can then paste it in the conditions at the required position.

  • Webservice Query: The behavior of this data source is the same as the Query, but this will accept only Webservice queries. The query support in Vtiger web services can be built from this data source.
  • CSV: Sometimes, you may receive information in a CSV file - an exported file from Google Sheets or any other 3rd party application. You can upload the CSV to an Insight Widget and configure it to display the data in the preferred output. You can upload a file up to 5MB.


  • The uploaded CSV must have a header row to identify column names. 
  • The data of CSV will be converted to a JSON format (key, value pair) with Header Name as key and respective row value as Value. The same will be forwarded to Transform and Output.
  • Custom Rest API: The Vtiger API Designer is a useful tool that you can use to build custom Rest APIs to connect with different applications. The Insight Designer lets you use custom Rest API as the input source. You can create custom REST APIs and connect them to the Insights Designer to help you fetch data from different external applications. 

Following is the flow to use a custom REST API in the Insight Designer:

  • Select the required API from the list of all the available APIs using the drop-down.
  • Request parameters are displayed if enabled in the selected API. (All request parameters are mandatory).
  • Fill in the details to test the API and fetch the response.
  • If request parameters are based on the filters, copy the filter merge tag and paste it into the API Parameter value.


  • Data retrieved from Query, Webservice Query, and CSV is limited to 1000 entries. 
  • Max upload size for CSV Input is 5MB.


The Transform tab will help you write a javascript code to transform the data you fetch from the data source. The code in the Transform tab will act on the fetched data and apply the required changes. The transformed data will then be moved to Output for visualization. 

Transform is auto-populated with the default javascript function, which returns the data as is. If you want to alter the data before the display, you can update this function and make changes. 


Note: The Function structure can not be changed. Only the content of the function can be changed. Modifying the function structure will not display the report. 



This is where you can set up the output configuration. That is, you configure the format in which the data must be displayed in the widget. 

You can visualize or display the output in the following types of reports:

  • Table 
  • Pivot
  • Metric
  • Pie Chart
  • Donut Chart
  • Bar Chart, Multi Bar, Stacked Bar 
  • Column Chart, Multi-Column, Stacked Column 
  • Line Chart, Multi-Line

You will need to configure the widget display when selecting the output type. Let us consider an example for each.

  • Table: By default, column names from the result are shown in Camel case text. You can add the column name in this configuration if you want to show different labels for each column. Columns are displayed only if you add different labels.
  • Pie chart: It expects the Label to categorize each Value. So you must fill in what column must be used as Label and Value from the result. 
  • Multi-column chart: It expects Category and Subcategory to group the Values. So you must fill in what columns must be used as Category, Sub Category, and Value from the result. 
  • Pivot: It expects group by rows, group by columns, and value columns. 
  • Metric: Metric is the count value that you want to display. The column in which you want this count must be configured. 

Resultant columns from the Input source from which the data is fetched and transformed must be used in this configuration. 

Line Item Fields

You can generate reports in the Insights Designer with the following values - Item name, Quantity, Net Price, and Grand total.

You can generate a report with line item field-level data for the following:

  • Products (Item name)
  • Quantity - Quantity of items (Products count in all deals)
  • Net Price - for getting SUM of all the deals
  • Product Category
  • Product sub-category

Feature Availability

One Pilot One Growth One Professional One Enterprise
Feature Availability
Insights Designer - - -


  • Number of Insights per edition - 5
  • Number of Widgets per Insight - 10
To know more about feature limits, click here.


The following are the benefits of using the Insights Designer:

  • Create custom reports for different departments.
  • Display actionable insights for easy understanding of what actions need to be taken.
  • Use APIs to create automated and filtered reports. 

In this article, we will learn about the following:

  • Accessing Insights Designer
  • Creating Insights page
  • Enabling Filters for a Report
  • Creating a Widget
  • Pinning Insights to Dashboard

Key Terminology


It is the capacity to gain an accurate and deep understanding of a user's performance. 


A report is a document that presents data or information in an organized format for a specific audience and purpose. 


It is a request for data results from your database, action on the data, or both. A query can give you an answer to a simple question, perform calculations, combine data from different tables, and add, change, or delete data from a database.


A Comma Separated Values (CSV) file is a plain text file that stores data by delimiting data entries with commas.

Accessing Insights Designer 

The Insights Designer in the CRM comes with its module.

Follow these steps to access Insights Designer:

  1. Log in to your CRM account.
  2. Click the Main Menu.
  3. Click Platform.
  4. Click Insights Designer. The List View of Insights is displayed.

Creating Insights Page

Creating an insight or a report involves the following:

  • Adding an insight 
  • Adding a widget

Adding an Insight

Follow these steps to create an Insights page:

  1. Log in to your CRM account.
  2. Click the Main Menu.
  3. Click Platform.
  4. Click Insights Designer
  5. In the List View, click +Add Insights. Add Insight window pops up.
  6. Enter or select information for the following:
    1. Name: Enter a name for the insight.
    2. Assigned to: Select a user from the drop-down.
  7. Click Save & Add Widgets. The Editing Insights page opens.

Adding a Widget

Follow these steps to create a widget:

  1. In the editing view, click +Add New Widget.
  2. Enter or select information for the following:
    1. Widget Details:
      1. Widget Name: Enter a name for the widget.
      2. Widget Description: Enter a brief description of the widget.
    2. Input:
      1. Query Type: Select the input query type from the drop-down.
      2. Based on the query type selected, select the dependent field.
    3. Transform (Depends on the Input):
      1. You can write javascript code to transform the fetched result. 
    4. Output (Depends on the Input):
      1. Output Type: Select the type of output widget from the drop-down.
      2. Output Configuration: It depends on the Output Type selected in the previous step. 
  3. Click Save

Enabling Filters for a Report

You can enable filters to an insight you are generating. Filters help you drill down data under different parameters to under the data source better. For example, you can enable filters such as Text, Picklist, Date, and Owner types.

Follow these steps to enable filters for a report:

  1. Log in to your CRM account.
  2. Click the Main Menu.
  3. Click Platform.
  4. Click Insights Designer
  5. In the editing view, click Edit Filters. Filters pop up appears.
  6. Click +Add Filter.
  7. Enter the field name to capture the data.
  8. Select the type of filter from the drop-down.
    1. Text: The system will filter the data based on a text or keyword in the record.
    2. Date: The system will filter the data based on the date in the record.
    3. Owner: The system will filter the data based on the owner of the record.
    4. Picklist: You can add a drop-down of filters. The system will filter the insights based on the filters from the drop-down.
  9. Click Save.

Pinning an Insight to Dashboard

You can pin the insights to your dashboard to access them quickly and frequently.

Follow these steps to pin an insight to the Dashboard:

  1. In the List View, click the required Insight.
  2. Click the More icon in the top right corner.
  3. Click the Pin icon. 

The insight is now successfully pinned to your dashboard. You can find the Insight page under Dashboard > Filter > Insights section. You can also share this Dashboard with any user like other dashboards.

Was this article helpful?
0  out of  0  found this helpful.
Comments 0
Be the first to comment
© Copyright 2023 Vtiger. All rights reserved.