Integrate with Segment.com

Learn how to integrate Flagship with Segment.com

How to integrate with Segment.com?

We already have the possibility to natively retrieve analytics information from Segment. This means that you will get all your tracking information (track/screen/page method) inside your Flagship reports depending on your visitors' assignment.
You can follow our support article to better know how our native Segment.com integration works.

Now, you might also want to send data from Flagship to Segment.com, to retrieve them into other tools. Hopefully, the method we're providing will help you reach that goal.

๐Ÿ“˜

Reminder

The following custom integration isnโ€™t under maintenance. It has been design to be generic, to work on the largest set of cases and codebase.
As a Yoda Master developer, you are the king of your own code.

The following code example takes into account that you already started your Flagship SDK and synchronized your user to get the flag (the modification) he should be assigned to.
The user is now seeing the flag, and you need to activate it, to alert us and count one more user in the corresponding report.
When activating it with our Flagship method, you will trigger the Segment method at the same time and send the information you need to, like in the code example below.

It also implies that you imported the Segment library before calling their method.

# Flagship campaign activation
  fsVisitor.ActivateModification("my_flag")

# Get Flagship campaign information and send it to Segment 
  modifInfos, _ := fsVisitor.GetModificationInfo("my_flag")

  data := analytics.Track{
    UserId: fsVisitor.ID,
    Event:  "Flagship_Source_Go",
    Properties: analytics.NewProperties().
      Set("cid", modifInfos.CampaignID).
      Set("vgid", modifInfos.VariationGroupID).
      Set("vid", modifInfos.VariationID).
      Set("isref", modifInfos.IsReference).
      Set("val", modifInfos.Value),
  }
  segmentClient.Enqueue(data)
// Flagship campaign user exposition
    
    Flag<String> myFlag = flagshipVisitor.getFlag("myFlag", "defaultValue");
    myFlag.userExposed();

// Get Flagship campaign information, map it, and send it to Segment

    JSONObject json = myFlag.metadata().toJSON();
    if (json != null) {
        Iterator<String> iterator = json.keys();
        HashMap<String, Object> values = new HashMap<>();
        while (iterator.hasNext()) {
            String name = iterator.next();
            values.put(name, json.opt(name));
        }
        Properties properties = new Properties();
        properties.putAll(values);
        Analytics.with(appContext).track("Flagship_Source_Java", properties);
    }
// ... some other codes

Flagship.start("<ENV_ID>", "<API_KEY>", {
  onUserExposure: ({ flagData, visitorData }) => {
    analytics.track(visitorData.visitorId, 'Flagship_Source_JS', flagData.metadata)
  }
})

//... do some stuff

// Then Calling flag.getValue() or flag.userExposed() anywhere will trigger onUserExposure callback
// Flagship campaign user exposition

    val myFlag =  flagshipVisitor.getFlag("myFlag", "defaultValue")
    myFlag.userExposed()
   

// Get Flagship campaign metadata, map it, and send it to Segment 

    val campaignMetadata = myFlag.metadata().toJson()
    campaignMetadata.keys().asSequence().associateWith { campaignMetadata[it]}.let { map ->
       val properties = Properties()
       properties.putAll(map)
       Analytics.with(appContext).track("Flagship_Source_Android", properties)
    }
// We assume you created visitor and fetched flags

// Retrieve the current visitor
FSVisitor * currentVisitor = [[Flagship sharedInstance] sharedVisitor];

// Get Flag object
FSFlag * myFlagObject = [currentVisitor getFlagWithKey:@"my_flag" defaultValue:@"defaultValue"];

// Expose the campaign
[myFlagObject userExposed];

//Get Flagship campaign information and send it to Segment
NSDictionary * campaign_metadata =  [[myFlagObject metadata] toJson];
[[SEGAnalytics sharedAnalytics] track:@"Flagship_Source_Objc" properties: campaign_metadata];
# Flagship campaign activation

    flagship_visitor.activate_modification("my_flag")

# Get Flagship campaign information and send it to Segment 

    campaign_info = flagship_visitor.get_modification_info("my_flag")
    analytics.track("#User123", "Flagship_Source_Python", campaign_info)
//... some other codes

<FlagshipProvider 
   onUserExposure={({ flagData, visitorData }) => {
    analytics.track(visitorData.visitorId, 'Flagship_Source_JS', flagData.metadata)
  }} >
 //... do some stuff

// Then Calling flag.getValue() or flag.userExposed() anywhere will trigger onUserExposure callback
</FlagshipProvider>
// We assume you created visitor and fetched flags

// Retrieve the current visitor
if let currentVisitor = Flagship.sharedInstance.sharedVisitor{
    
    // Get the flag object
    let myFlagObject = currentVisitor.getFlag(key: "my_flag", defaultValue:"defaultValue")
    
    // Expose the campaign
    myFlagObject.userExposed()
    
    // Get Flagship campaign information and send it to Segment
    let campaign_metadata =  myFlagObject.metadata().toJson()
    Analytics.shared().track("Flagship_Source_ios", properties: campaign_metadata)
}
// Flagship get flag

$flag = $fsVisitorInstance->getFlag('my_flag', 'defaultValue');

// Flagship campaign activation

$flag->getValue();

// or

$flag->userExposed();

// Get Flagship campaign information and send it to Segment


$campaignInfo = $flag->getMetadata();

Segment::track([
    "userId" => $fsVisitorInstance->getVisitorId(),
    "event" => "Flagship_Source_PHP",
    "properties" => $campaignInfo
]);

How to verify the hit in Segment?

After you successfully integrate with Segment, you can check in your Segment's Source Debugger if the hit is correctly sent with all the information needed.

An example of properties passed for an iOS application:

24222422

Any feedback? We would be really happy to have a quick chat!