ClearBrain automatically connects to your user data in Segment. We collect all your Segment identifies, pages, screens, and track events to enable you to predict any user action you've tracked via Segment.
Step 1: Create a Segment Connection in ClearBrain
In the ClearBrain app, go to the Connections Tab, and click the "New Connection" button. Choose the Segment option, and a list of form fields will appear:
- Connection Name: Give your connection a unique name; this is the name the connection will display with in ClearBrain
- Source Type: Indicate the type of data you are importing from your Segment project. Types include: Web, iOS, Android
Click "Create Connection", and you will be presented with a series of Follow Up Steps.
In the Follow-up Steps screen, you'll be given your ClearBrain API key which you will use to configure your ClearBrain destination in Segment. To complete this process though, all you have to do is click the "Enable with Segment" button, and you will be automatically redirected to Segment.
Step 2: Create an ClearBrain Destination in Segment
Once redirected to Segment, you'll be presented with the screen above.
From the drop-down modal, select the Segment Source that you would like to configure with ClearBrain.
Once selected, click "Send Data" and your Segment Source will now be sent to ClearBrain!
Note: You can also configure your ClearBrain destination directly in Segment, by going directly to the link here, and manually entering the API key generated in Step 1.
Step 3: Processing your data from Segment
After you've created your Segment + ClearBrain connection, we'll start ingesting your user data. To create predictive goals however, we'll need a minimum of 2 weeks of historical data.
To accelerate this process, you can use Segment's Historical Replay feature. This enables you to send all your historical data to ClearBrain. Contact your Segment account manager to enable this feature.
In either case, you will be notified automatically by ClearBrain when enough historical data has been collected, and you can start creating predictions in ClearBrain.
(Optional): Creating a Segment Export Connection
ClearBrain also allows you to export your user predictive scores back into Segment.
To do so, go to the Segment UI, and find the API Write Key for the Segment Source you want to export your scores back into. You can find the API Write Key in your Segment Source Settings --> API Keys tab.
With the Write Key copied, return to the ClearBrain UI and open the Segment Connection you have saved. Enter the API Key you copied into the field "API Write Key".