Connecting to analytics vendors

Retool’s analytics feature makes it easy to collect analytics from your apps, and supports integrations with Segment and Google Analytics.

🚧

Integration with third-party analytics vendors is only available on the Enterprise plan.

Getting Started

In the Settings > Advanced tab, an Instrumentation section has options to integrate with third party analytics vendors. Retool's Enterprise plan currently supports Segment, Google Analytics, and logging to standard out.

Events will be sent to all enabled integrations.

Configuration

Once analytics have been enabled, a new type will appear in the "+ New" dropdown in the bottom panel.

Each analytics event has 3 configurable sections: when to trigger, what conditions have to be met, and what fields should be included in the payload.

Here’s an example of an event that is triggered when query1's finished property changes, and the query returns more than 10 items. The payload includes the current time, the user who triggered the query, how long the query took to run, and the value of textinput1.

Triggering

The instrumentation event will be triggered when any of the listed plugin properties have changed. If you want to limit when the payload is sent, enable a condition. The condition can access properties outside of your “trigger when” clauses.

Google Analytics guide

If you would like to track additional properties that are not directly built into Google Analytics, you will have to use custom dimensions.

Here's a guide on how you can define additional custom dimensions, map them in Retool, and then track them in analytics events.

  1. Create the custom dimensions

Navigate to your Admin section, and then click on Custom Dimensions. From there, you can create up to 20 custom dimensions. In this screenshot, we've configured three dimensions - user tier, user group, and user region.

  1. Map the dimensions in Retool

After creating the dimensions, you need to map them to dimensions in Retool. For an existing integration, click “Edit configuration” in “Advanced settings”:

In the modal, map the dimensions you'd like to track here. The index should be the exact same as it appears in the Google Analytics settings page.

Now when those keys are included in your analytics event payloads they will show up in your GA dashboard.

  1. Verifying that the integration is sending events to Google Analytics

Try making an analytics event like this and then manually triggering it a few times.

After that you should immediately start seeing active users in your Realtime Dashboard to see active users.

  1. Verifying that the custom dimensions are being picked up in Google Analytics

Google Analytics has a moderate processing time before the custom dimensions will start showing up (roughly 15-30 minutes). Once that time has passed, you can create a Custom Report to visualize the data from your custom dimensions.


Did this page help you?