Connect to analytics vendors
Learn how to enable analytics for your Retool apps.
Retool’s analytics feature allows you to collect analytics from your apps, and it supports integrations with Segment and Google Analytics.
Your organization must be on the Enterprise plan to use analytics features.
Get started
There's an Analytics section on the Settings > Advanced tab in Retool. From there, you can connect to Segment and Google Analytics. You can also log to standard out. After connecting, events are sent to all enabled integrations.
Configuration
After connecting, you can create Analytics tracking queries in the App IDE.
Each analytics event has three configurable sections: when to trigger the query, what conditions have to be met, and the fields to include in the payload.
This example triggers when the finished property of query1 changes, and only runs if the query returns more than 10 items. The payload includes the current time, the user that triggered the query, how long the query took to run, and the value of the textInput1 component.
Triggering
The instrumentation event triggers when any of the listed properties change. If you want to limit when the payload is sent, enable a condition. The condition can access properties outside of your Trigger On Property Change clauses.
Google Analytics guide
If you want to track additional properties that are not built into Google Analytics, you 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 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.
2. Map the dimensions in Retool
After creating the dimensions, map them to dimensions in Retool. For an existing integration, click Edit configuration in Advanced settings:
In the modal, map the dimensions you want to track. 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 show up in your Google Analytics dashboard.
3. Verify the integration sends 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.
4. Verify your custom dimensions in Google Analytics
Google Analytics has a moderate processing time before the custom dimensions 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.
