The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.
Use loyalty incentives to encourage your customers to provide information about themselves and their shopping habits. With Antavo’s Gamified profiling module, you can ask a set of questions that you would like customers to answer and give points in return for completing the survey by assigning a point value for each question set. You can use the dedicated endpoints of the Display API to add the configured questions flow to your membership site.
After collecting all this information, use this data across marketing activities by creating an export or syncing them to your newsletter provider.
The module introduces the factory profiling_answer and profiling_flow events.
The
profiling_answerevent is registered on the customer’s event history when an answer to a configured question is submitted through a request sent to the Display API.The
profiling_flowevent is automatically written down if no question, that you have added to a profiling survey, is left unanswered by the customer.
The profiling_answer and profiling_flow events are internal, meaning that these events cannot be registered by sending requests via the Events API.
| Table of Contents |
|---|
Find the configuration page by clicking the 
icon in the main sidebar. The page will open to the list of profiling flows that are already set up with the following information:
Name of the flow
A text label, immediately below the unique ID, specifies if the account is Active or Inactive.Points awarded for answering the questions
| Info |
|---|
In case you use the Multi-language module, all text-type factory configuration fields of both flows and questions are translatable and returned by the Display API if requested. Please note, that custom attributes added in the Custom entities module cannot be translated on the platform. |
Adding a new question
Click the ‘Create’ button on the top right-hand corner of the Questions page or the ‘Create new question’ option in the sidebar
...
To save the customer’s answer as a customer data field, tick the checkbox and select the field to save the answer to.
Learn more about the customer fields and how to create them here.
...
Note that if answers and tags (that you’ll define under ‘Answer settings’ later on) do not match the format of the selected customer field, then customers won’t be able to answer the question. You can find the required format of each field on the Customer fields page under the Customers tab of the Settings menu.
...
Click ‘Create new flow’ in the module sidebar
Enter the name of the flow
Write a description
Add the number of points customers should get for answering all questions in the flow
Select customer segments who can answer the questions
Read more about segments here.Decide if you want the flow to be visible for the selected segments only
If the checkbox is ticked and the customer is not in the selected segment, the flow may appear as a restricted item on the membership site.Add the start and end dates
The Display API endpoint returns active flows between the configured start and end dates.Upload an image
...
Please note, that the flow completion settings are not available through the Entities API yet, currently, this serves informative purposes only.
Points economy
If your brand uses Multi-accounts, select the account to which the related events and earn points should be registered.
...
Don’t forget to click ‘Create’ before leaving the page.
...
You can add further configurable attributes to the flows via the Custom entities extension by extending the 'Gamified profiling - Flow' factory entity. The newly defined, activated attribute will be added to the flow editor page as a configurable field.