ATC/Current/SDK/Form tracking API - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

2021-11-09T21:27:48Z

Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

2021-08-10T10:35:35Z

Published

Barbara.martin@genesys.com: Published

2021-04-28T18:30:05Z

Published

Barbara.martin@genesys.com: Published

2020-12-16T18:46:20Z

Published

Barbara.martin@genesys.com: Published

2020-11-04T13:33:53Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:31:20Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

2020-07-15T12:00:33Z

Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:44:24Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

2020-01-28T11:27:12Z

Published

Show changes

WikiSysop at 13:34, January 17, 2020

2020-01-17T13:34:11Z

@@ Line 9: / Line 9: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
+|structuredtext={{NoteFormat|1=This article only applies to customers using {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_chats|display text=web chat}}. If you are a Genesys Cloud CX customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.|2=}}<br />
 |Status=No
 }}{{Section

@@ Line 3: / Line 3: @@
 |DisplayName=Form Tracking API
 |TocName=Form Tracking API
-|Context=Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
+|Context=Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.
 |Dimension=FormTrackAPI
 |ComingSoon=No
 |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=About the Form Tracking API
 |alignment=Vertical
@@ Line 56: / Line 60: @@
 <!--Form 1-->
      <h3>Get Name Form</h3>
-     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
+     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
        First name:<br>
        <input type="text" name="firstname">
@@ Line 68: / Line 72: @@
 <!--Form 2-->
      <h3>Get Account Information Form</h3>
-     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
+     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
        Account No.:<br>
        <input type="text" name="account">
@@ Line 80: / Line 84: @@
 <!--Form 3-->
      <h3>Register for Newsletter Form</h3>
-     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
+     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
        First name:<br>
        <input type="text" name="firstname">

@@ Line 3: / Line 3: @@
 |DisplayName=Form Tracking API
 |TocName=Form Tracking API
-|Context=Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.
+|Context=Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.{{BarbFeatureTemp|Feature=Web messaging}}This article only applies to customers using web chat. If you are a Genesys Cloud customer, we encourage you to use the new {{Link-AnywhereElse|product=ATC|version=Current|manual=AdminGuide|topic=About_web_messaging|display text=web messaging}} feature to replace web chat.
 |Dimension=FormTrackAPI
 |ComingSoon=No
@@ Line 56: / Line 56: @@
 <!--Form 1-->
      <h3>Get Name Form</h3>
-     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
+     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
        First name:<br>
        <input type="text" name="firstname">
@@ Line 68: / Line 68: @@
 <!--Form 2-->
      <h3>Get Account Information Form</h3>
-     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
+     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
        Account No.:<br>
        <input type="text" name="account">
@@ Line 80: / Line 80: @@
 <!--Form 3-->
      <h3>Register for Newsletter Form</h3>
-     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
+     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
        First name:<br>
        <input type="text" name="firstname">

@@ Line 3: / Line 3: @@
 |DisplayName=Form Tracking API
 |TocName=Form Tracking API
-|Context=Learn how to use an API to track form submission and abandonment events, including what visitors enter in your forms.
+|Context=Learn how to use an API to track form submission and abandonment events, including what information visitors provide in your forms.
 |Dimension=FormTrackAPI
 |ComingSoon=No
@@ Line 10: / Line 10: @@
 |sectionHeading=About the Form Tracking API
 |alignment=Vertical
-|structuredtext=In order to track customer activities on your website, you must first {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=deploy the tracking snippet}}. After you do that, you can track form-level activity with the Form tracking API.
+|structuredtext=To track customer activities on your website, you must first {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Tracking_snippet|display text=deploy the tracking snippet}}. Then, you can track form-level activity with the Form tracking API.
-In order to be tracked, a form must have an ID, name, or action field that uniquely identifies it. By default, the values of the input, select, and textarea elements entered in the form (fields with personal information such as name, email, phone number and company name) are sent with the form submission and abandoned events. The customer profile is updated accordingly upon form submission.
+To track a form, it needs an ID, name, or action field that identifies it uniquely.
-{{NoteFormat|You can use {{MintyDocsProduct}} to track visitor activity in a GDPR compliant-manner, however, you must modify the tracking snippet in order to be compliant. For more information on how to be compliant with the GDPR requirements, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.|}}
+By default, the values of the input, select, and text area elements provided in the form (fields with personal information such as name, email, phone number, and company name) are sent with the form submission and abandoned events. The customer profile updates accordingly upon form submission.
 |Status=No
 }}{{Section
@@ Line 25: / Line 27: @@
 </source>
-To enable tracking for all forms call the function without specifying the selector. For example:
+To enable tracking for all forms, call the function without specifying the selector. For example:
 <source lang="javascript">
 ac('forms:track');
 </source>
-To enable tracking for multiple forms based on the CSS selector specify a group of selectors as a comma-separated list. For example:
+To enable tracking for multiple forms based on the CSS selector, specify a group of selectors as a comma-separated list. For example:
 <source lang="javascript">
 ac('forms:track', '#firstFormId, #secondFormId');
 </source>
-{{NoteFormat|Where the same selector is applied to multiple forms, each form with that selector will be tracked separately.|1}}
+{{NoteFormat|Where the same selector is applied to multiple forms, each form with that selector is tracked separately.|1}}
 <source lang="javascript">
@@ Line 54: / Line 56: @@
 <!--Form 1-->
      <h3>Get Name Form</h3>
-     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
+     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
        First name:<br>
        <input type="text" name="firstname">
@@ Line 66: / Line 68: @@
 <!--Form 2-->
      <h3>Get Account Information Form</h3>
-     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
+     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
        Account No.:<br>
        <input type="text" name="account">
@@ Line 78: / Line 80: @@
 <!--Form 3-->
      <h3>Register for Newsletter Form</h3>
-     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
+     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
        First name:<br>
        <input type="text" name="firstname">
@@ Line 118: / Line 120: @@
 |sectionHeading=Manage form field data
 |alignment=Vertical
-|structuredtext=To manage how form field data is sent with form submission and abandonment events, use the <tt>captureFormDataOnAbandon</tt> and <tt>captureFormDataOnSubmit</tt> options with the forms:track method. Set these options to <tt>true</tt> or <tt>false</tt>, depending on the result you want to obtain.
+|structuredtext=To manage how form field data is sent with form submission and abandonment events, use the <tt>captureFormDataOnAbandon</tt> and <tt>captureFormDataOnSubmit</tt> options with the forms:track method. Set these options to <tt>true</tt> or <tt>false</tt>, depending on the result that you want to obtain.
 For example, to record a form abandonment event, but exclude any form field data, set <tt>captureFormDataOnAbandon</tt> to <tt>false</tt>.
@@ Line 128: / Line 130: @@
 </source>
-{{NoteFormat|If you do not set the <tt>captureFormDataOnAbandon</tt> option, or you set it to anything other than <tt>false</tt>, the option assumes the value is <tt>true</tt>, and the recorded form abandonment event will contain serialized form data. This data is subject to custom transformation; sensitive fields are automatically excluded. For more information, see [[#TransformData|Transform data before sending it]] and [[#UntrackedFields|Sensitive form fields that are never tracked]].}}
+{{NoteFormat|If you do not set the <tt>captureFormDataOnAbandon</tt> option, or you set it to anything other than <tt>false</tt>, the option assumes that the value is <tt>true</tt>, and the recorded form abandonment event will contain serialized form data. This data is subject to custom transformation; sensitive fields are excluded. For more information, see [[#TransformData|Transform data before sending it]] and [[#UntrackedFields|Sensitive form fields that are never tracked]].|}}
 To capture serialized form data for form submission events, set the <tt>captureFormDataOnSubmit</tt> option to <tt>true</tt>.
@@ Line 144: / Line 146: @@
 |sectionHeading=Transform data before sending it
 |alignment=Vertical
-|structuredtext=To configure the format of the data that is sent with the form submission and abandonment events, specify a custom <tt>transform</tt> function in the <tt>forms:track</tt> options. This function receives an object with the form data; it should return an object with the data to be sent with the form events. You can exclude certain fields, rename fields that are not meaningful, or make any other transformations to the form data before it is sent. The data object is a JSON object of "name-value" pairs, where:
+|structuredtext=To configure the format of the data that is sent with the form submission and abandonment events, specify a custom <tt>transform</tt> function in the <tt>forms:track</tt> options. This function receives an object with the form data; it should return an object with the data to send with the form events. You can exclude certain fields, rename fields that are not meaningful, or make any other transformations to the form data before it is sent. The data object is a JSON object of "name-value" pairs, where:
-*"name" is the value of the element's id or name attribute
+*"name" is the value of the element's ID or name attribute
 *"value" is the visitor's input

@@ Line 6: / Line 6: @@
 |Dimension=FormTrackAPI
 |ComingSoon=No
-|Platform=GenesysEngage-cloud, PureConnect, GenesysCloud
+|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 |Section={{Section
 |sectionHeading=About the Form Tracking API
@@ Line 14: / Line 14: @@
 In order to be tracked, a form must have an ID, name, or action field that uniquely identifies it. By default, the values of the input, select, and textarea elements entered in the form (fields with personal information such as name, email, phone number and company name) are sent with the form submission and abandoned events. The customer profile is updated accordingly upon form submission.
-{{NoteFormat|You can use Altocloud to track visitor activity in a GDPR compliant-manner, however, you must modify the tracking snippet in order to be compliant. For more information on how to be compliant with the GDPR requirements, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.}}
+{{NoteFormat|You can use {{MintyDocsProduct}} to track visitor activity in a GDPR compliant-manner, however, you must modify the tracking snippet in order to be compliant. For more information on how to be compliant with the GDPR requirements, see {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=GDPR}}.|}}
 |Status=No
 }}{{Section
@@ Line 54: / Line 54: @@
 <!--Form 1-->
      <h3>Get Name Form</h3>
-     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
+     <form id="get-name" data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  data-origID="get-name"  action="/submit-name">
        First name:<br>
        <input type="text" name="firstname">
@@ Line 66: / Line 66: @@
 <!--Form 2-->
      <h3>Get Account Information Form</h3>
-     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
+     <form id="get-account-information" data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  data-origID="get-account-information"  class="target-class" action="/submit-account">
        Account No.:<br>
        <input type="text" name="account">
@@ Line 78: / Line 78: @@
 <!--Form 3-->
      <h3>Register for Newsletter Form</h3>
-     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
+     <form id="register-for-newsletter" data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  data-origID="register-for-newsletter"  class="target-class" action="/submit-newsletter">
        First name:<br>
        <input type="text" name="firstname">

ATC/Current/SDK/Form tracking API - Revision history

Ed.jamer@genesys.com: Text replacement - "Genesys Cloud" to "Genesys Cloud CX"

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

Barbara.martin@genesys.com: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureCloud([\|]*)" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

DannaShirley: Published

WikiSysop at 13:34, January 17, 2020

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureCloud([\|])" to "|Platform=$1GenesysCloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"