Survey Properties
Configuration
You can configure the on-site survey properties as described below.
Property | Type | Description | Default value |
|---|---|---|---|
|
| Identify a specific survey using its |
|
|
| If set to true, targeting rules specified in the dashboard for the active surveys are not executed. Thus, all the active surveys, unless |
|
|
| If set to true, the submitted or closed surveys also become eligible to be shown. |
|
|
| Time delay, in milliseconds, to show a survey on a page. This overrides the time delay specified on the dashboard while creating the survey. | As set on the dashboard |
|
| If set to |
|
|
| Specify your custom data for survey here in |
|
|
| Specify your rule data here in |
|
|
| A visitor lifecycle depends on a long term cookie installed for your website on a browser. Lifecycle of a survey depends on the scope of a visitor. If a survey is closed, it doesn't appear for the visitor in the same browser session. If a survey is submitted, then it doesn't appear for the same visitor ever again. If you want a survey to appear in every new browser session irrespective of the survey being submitted in a past session, you can define your own scope. In this case, specify scope as |
|
|
| By defining custom scope, you can ensure that a survey is submitted only once in that scope. By specifying the By specifying the |
|
Usage Examples
- Pass business data for custom rules.
webengage.survey.options('ruleData', {
'itemsInCart' : 3,
'cartAmount' : 1288,
'customerType' : 'gold'
});
- Show surveys to a visitor everytime a new browser session starts.
By specifying a session_id (some unique identifier for a browser session) as the survey scope with scopeType as 'session', one can make a survey re-appear to a visitor, even if the visitor has closed or submitted it in a previous browser session.
webengage.survey.options({
'scope' : '_USER_SESSION_ID_',
'scopeType' : 'session'
});
- Show a survey to a visitor every day irrespective of them closing/submitting the same survey.
By specifying today's date as the survey scope, one can make a survey re-appear to a visitor each day even if the visitor has closed or submitted it.
var today = new Date();
webengage.survey.options('scope', {
'scope' : (today.getDate()+"-"+today.getMonth()+"-"+today.getYear()),
'scopeType' : 'session',
'surveyIds' : ["~29aj48l"]
});
- Show a survey once to a user logged in from different browsers.
If you want a survey to be submitted once per logged in user irrespective of different browser sessions, then the specify logged in user's email or userId as the scope with scopeType as global.
webengage.survey.options({
'scope' : '_USER_EMAIL_',
'scopeType' : 'global'
});
Survey Methods
webengage.survey.render()
This method allows you to override survey settings as configured on WebEngage dashboard. It also overrides any provided global configuration properties on the page. This method accepts all survey configuration properties.
Usage Examples
- Open a survey on click of a button.
webengage.survey.options({
'surveyId' : '_SURVEY_ID_', // survey id to be rendered ... note : it is optional
'defaultRender' : false
});
webengage.onReady(function(){
document.getElementById("_BUTTON_ID_").onclick = function () {
webengage.survey.render();
};
});
- Open a survey on page scroll (down).
webengage.survey.options({
'defaultRender' : false
});
(function () {
var getScrollPercentage = function () {
var documentHeight = $(document).height();
var viewPortHeight = $(window).height();
var verticlePageOffset = $(document).scrollTop();
return Math.round(100* (viewPortHeight+verticlePageOffset)/documentHeight);
}
var surveyDisplayed = false;
webengage.onReady(function(){
window.onscroll = function (event) {
if (!surveyDisplayed && getScrollPercentage() >= 70) {
webengage.survey.render({ surveyId : '_SURVEY_ID_' }); // invoking webengage.survey.render with specific survey id
surveyDisplayed = true;
}
}
});
})();
Please scroll down a bit to see this in effect.
Also, note that we are callingwebengage.survey.renderby passing itsurveyIdoption.
- Pass custom data / rule data.
webengage.survey.options({
'defaultRender' : false
});
webengage.survey.options('ruleData', { 'categoryCode' '_CATEGORY_CODE_', 'paidCustomer' : true });
webengage.onReady(function(){
document.getElementById("_BUTTON_ID_").onclick = function () {
webengage.survey.render({
'customData' : { 'userId' : '_USER_ID_', 'age' : _AGE_ }
});
};
});
- Track survey view in console.
webengage.survey.options({
'defaultRender' : false
});
webengage.onReady(function(){
document.getElementById("_BUTTON_ID_").onclick = function(){
webengage.survey.render().onOpen( function(){
console.log("survey open");
});
};
});
webengage.survey.clear()
This method clears any rendered survey.
Usage Example
- Clear a survey on click of a button.
webengage.onReady(function(){
document.getElementById("_BUTTON_ID_").onclick = function () {
webengage.survey.clear();
};
});
Please feel free to drop in a few lines at [email protected] in case you have any further queries. We're always just an email away!
Updated about a year ago