API

Segment out your users for targeted in-app messages

Create user segments, so you can send them targeted In-app messages.

What is a segment? 

A segment is a group of your users separated based on shared characteristics that you set - for example, you might segment your users based on language preferences, product version, geographical region or user persona etc.

Your users are automatically added to the segment every time they get updated and match those characteristics or rules. 

Create a segment in Faqprime

  1. Head over to the admin section 

  2. Click on  ‘Preferences’ 

  3. Find ‘Segment Configuration’

  4. Enter the segment(s) separated by a comma.

IMP: The default segment is ‘all’ i.e. all the users.

Using the segment in an in-app messaging campaign

  1. Head over to Popup Manager

  2. Click on ‘My Campaigns’ or Create a new campaign by duplicating a template 

  3. Enter the segment list (choose from the auto-suggestion) 

  4. Click on 'Save and Next'.

Setting up targeted in-app message for a user segment via JavaScript API: ‘faqbotGetUserSegment()

To determine the messages that should be displayed to the current user. Faqprime shall check if the function is defined in your code. If yes, then it shall call the function to return the segment (a string or an array) for the current user.

Note: If this function is not defined the current user segment is assumed as 'all' (the default segment) 

For example:

function faqbotGetUserSegment() {
       return "even";
}

function faqbotGetUserSegment() {
       return ["even", "all"];
}

 

 

Did this answer your question?
...