Overview

Gtmhub connects to over 150 business systems and allows you to automate your OKRs using data from those systems so manual updates are not required. To do this, you can build insights that properly aggregate the source system data to get the number you need to update your key results.

To make a key result automated, you link it to an insight that calculates the number that should be used to update the key result. Insights help you calculate and visualize important metrics about your business. For more information, see Create insights with SQL.

Key Results can be made automated in two ways. They can be created from an insight that supports automated key result creation through the <metric> component, or made automated using the "Automate" button on the key result edit screen. Note that the "Automate" button is only available to those with Manage Data permissions, which by default is the admin and data roles.


Requirements for an Insight to be used to automate Key Results

  • The SQL for the insight must return a numeric value in a column/field for that column/field to be usable for key result automation

    • Hint: String values can be casted to numbers if necessary

  • The SQL should return a single row of data. If multiple rows of data are returned and a key result is linked to the insight, the first row of data will be used

  • The HTML has no effect on the value that is used to automate key results. I.E. you cannot use JavaScript to manipulate the value returned from the SQL. The value must be calculated in SQL


Allow Creating New Automated Key Results from Insightboards

To be able to create automated key results from an insightboard, the insight(s) on the insightboard display the number in a <metric> HTML tag.

The <metric> tag will render a green dot when you hover over your insight number. When you click this dot, a wizard opens. It guides you through the steps to create your automated key result (or KPI).

For more information, see Example: Create an insight with metrics.


Allow Insights to be used from the "Automate" button

After clicking "Automate", a user is presented a list of data sources. After selecting the data source, the user will be presented a select list of insights that can be used.

Only scalar insights are shown in this list. A scalar insight is an insight with SQL that returns a single numeric value (one row, one column/field). Non-scalar insights will not be displayed in the list and are not available for selection.

After selecting a scalar insight, the user can confirm the value and if necessary change any insightboard parameters that are used on that insight to get the correct value for the key result.

Users also have the choice at this point to use the "Automate it yourself" option which will allow them to set up a codeless insight. Codeless insights have limited functionality compared to SQL insights, so SQL insights are generally recommended to be used when possible for automating key results.


See also

Example: Create a dynamic key result

Create insights with SQL


Did this answer your question?