Survey APIs to Trigger Custom Events in Wingify – Wingify

close this to read article

Studying your customers and taking a calculated guess on what they like is one thing. Hearing the same straight from the customers is another thing altogether. That’s why surveys are the best. Nothing speaks like a survey for it’s the tool that carries the affidavit of the customer’s experience through your website. You can use the Surveys feature in Wingify to listen to your customers. When you have the right questions to source the extract of your customers’ experience, you are all set to go. Just frame your questions, set an ideal location, use a default theme or custom-create one for the survey to be displayed, and choose a language. Your survey is ready!

But that’s not all. You can even add custom events like pushing your Wingify survey data to third-party analytics tools and streamline your data analysis.

You can add custom functionality using the following available APIs in Wingify Surveys:

Wingify Survey Shown API

This is the API through which you will be able to add custom functionality when the survey is shown to the visitor.

window.VWO = window.VWO || [];
window.VWO.push(['onSurveyShown', function (data) {
   // Add your code here
}]);

window.Wingify = window.Wingify || [];
window.Wingify.push(['onSurveyShown', function (data) {
// Add your code here
}]);

The following is a sample data object that will be included in the callback function:

{
   "accountId": 1000047,
   "surveyId": 296,
   "uuid": "D4F232BA23BBA4EE9D1C1ACB47DB8BA9D"
}

The above example features the following details in the callback function using which you can obtain the survey data correspondingly:

accountId (Wingify Account ID)
surveyId (The unique survey campaign ID)
uuid (The unique ID given to a visitor that arrives at your website where Wingify SmartCode is enabled).

Wingify Survey Answer Submitted API

This is the API through which you will be able to add custom functionality when a visitor submits a survey answer.

window.VWO = window.VWO || [];
window.VWO.push(['onSurveyAnswerSubmitted', function(data) {
   // Add your code here
}]);

window.Wingify = window.Wingify || [];
window.Wingify.push(['onSurveyAnswerSubmitted', function(data) {
// Add your code here
}]);

The data in the callback function will include the details of the visitors that have attended the survey along with the details of the survey question and the corresponding response as provided by the visitors.

For instance, if you wish to push the data to GA as soon as the visitor submits the answer to a survey question, you can use the following code snippet:

window.VWO = window.VWO || [];
window.VWO.push(['onSurveyAnswerSubmitted', function(data) {
  if (!data) {
      return;
  }
  window.dataLayer.push({"SurveyId" : data.surveyId, "QuestionType" : data.questionType, "QuestionText" : data.questionText, "answer": JSON.stringify(data.answers)});
  window.dataLayer.push({event: 'VWO-survey-answer-submitted'});
}]);

The following are sample data objects that will be included in the callback function:

For Multi-line Answers

Assuming that the visitor is asked a question that requires them to provide an answer in a few words, the data object will be as follows.

{
   "accountId": 307590,
   "surveyId": 293,
   "uuid": "D37EF4336FD3C784165C6D2BEBDACE430",
   "questionId": 2005,
   "questionType": "multi_line",
   "questionText": "What could we do to make this site more useful?",
   "answers": [
       {
           "id": 1,
           "value": "Add multiple theme options"
       }
   ],
}

For Multiple Choice Questions

If it is a multiple-choice question, the data object will be as follows.

{
   "accountId": 307590,
   "surveyId": 293,
   "uuid": "D37EF4336FD3C784165C6D2BEBDACE430,
   "questionId": 2009,
   "questionType": "checkbox"
   "questionText": "Pick your favorite colors",
   "answers": [
       {
           "id": 1,
           "value": "red"
       },
       {
           "id": 2,
           "value": "blue"
       }
   ],
}

For Skipped Questions

For any optional question skipped by a visitor, the data object will have an additional parameter - “skipped”, set to ‘true’ as shown below.

{
   "accountId": 307590,
   "surveyId": 294,
   "uuid": "DA51D3A9F3AC3AF95A64A84BC3375F731",
   "questionId": 2021,
   "questionText": "STATES YOU'VE BEEN TO?",
   "skipped": true,
   "questionType": "radio"
}

Wingify Survey completed API

Through this API you can add custom functionality when the visitor completes the survey.

window.VWO = window.VWO || [];
window.VWO.push(['onSurveyCompleted', function (data) {
   // Add your code here
}])

window.Wingify = window.Wingify || [];
window.Wingify.push(['onSurveyCompleted', function (data) {
// Add your code here
}])

The data in the callback function will include accountId, surveyId and uuid, using which you can track when a survey is completed.

Thus, you can customize Wingify Survey to make it your own and gain the actionable insights that you need from customer responses to make better business decisions.

Articles in this section