Survey Step Complete

Fire whenever a user successfully completes a survey step/section.

This event is fired when a step/section of a survey is successfully received and processed. This is in contrast to survey_error which occurs when a submission is attempted but an error occurs and the survey input is not received and processed.

Personally Identifiable Information Avoidance

It is important to note that the step_choice attribute which can possibly include PII (e.g. freeform input fields, first name, last name, email address, home address, etc.) should be EXCLUDED from this data layer event. For more information, please visit Understanding PII in Google's contracts and policies.

Javascript Code

// When:
// User successfully completes a survey step/section
// NOTE: step_choice attribute may contain PII data and should be excluded from this event where applicable

// Code:
window.dataLayer = window.dataLayer || [];
dataLayer.push({ event_data: null });  // Clear the previous event_data object.
dataLayer.push({
  event: 'survey_step_complete',
  event_data: {
    identifier: '<identifier>', // REQUIRED | string | ex. cancel_subscription_flow, free_trial
    name: '<name>', // REQUIRED | string | ex. cancel_subscription_flow, free_trial
    type: '<type>', // REQUIRED | string | ex. survey, lead_generation
    step_choice: '<step_choice>', // REQUIRED | string | Radio buttons or select lists only | ex. Too Expensive,Using Another Product/Brand
    step_choice_method: '<step_choice_method>', // REQUIRED | string | ex. automatic, user-selected
    step_name: '<step_name>', // REQUIRED | string | ex. why_are_you_cancelling, which_product
    step_number: '<step_number>' // REQUIRED | integer | ex. 1, 2, 3,4,5
  }
});

Variable Definitions

Field	Type	Required	Description	Example	Maximum Length
identifier	string	required	The survey machine-readable name. This should be a unique value specific to this survey, if one exists. If one does not exist, this can also be populated with the same value as the name.	cancel_subscription_flow, free_trial	100
name	string	required	The survey human-readable name. This should be something that an analyst without a deep knowledge of the technical implementation of the site can easily identify the survey with. It should be lowercase snake_case.	cancel_subscription_flow, free_trial	100
type	string	required	The survey type. This will act as a filtering mechanism in reporting to enable analysts to view survey droppoff funnels. It can also act as an internal aid in firing additional events if necessary. For instance, lead-generating surveys require a generate_lead event to be fired alongside complete_survey, and that could be written into the logic based upon this field.	survey, lead_generation	100
step_choice	string	required	The human-readable, user-selected value(s) within a step/section of a survey.	Too Expensive,Using Another Product/Brand	100
step_choice_method	string	required	This was initially scoped for skin360 as the survey can assign you a primary skin concern or you can choose one yourself. It can be used beyond that application for any time you need additional context around the step choice.	automatic,user-selected	100
step_name	string	required	The human-readable name of the current step of the survey.	why_are_you_cancelling,which_product	100
step_number	integer	required	The current step/section integer of the survey flow.	1,2,3,4,5	100