Difference between revisions of "ATC/Current/SDK/Forms: track"

From Genesys Documentation
Jump to: navigation, search
(Published)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=forms:track
 
|DisplayName=forms:track
−
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=forms:track
 
|TocName=forms:track
 +
|Context=Learn how to use the<tt>forms:track</tt> method to capture when users complete web-based forms.
 +
|Dimension=FormTrackAPI
 
|ComingSoon=No
 
|ComingSoon=No
−
|Dimension=FormTrackAPI
+
|Platform=PureEngage, PureConnect, PureCloud
−
|Context=Learn how to use the<tt>forms:track</tt> method to capture when users complete web-based forms.
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=Description
 
|sectionHeading=Description
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=The <tt>forms:track</tt> method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form.   
 
|structuredtext=The <tt>forms:track</tt> method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form.   
Line 19: Line 17:
  
 
See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}.
 
See also {{Link-SomewhereInThisVersion|manual=SDK|topic=Form_tracking_API}}.
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=<tt>ac('forms:track', [selector], [options]);</tt>
 
|structuredtext=<tt>ac('forms:track', [selector], [options]);</tt>
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=*[[#selector|selector]]
 
|structuredtext=*[[#selector|selector]]
 
*[[#options|options]]
 
*[[#options|options]]
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=selector
 
|sectionHeading=selector
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=*Description: The element you want to track.
+
|structuredtext=*Description: The CSS selector for the element or elements you want to track.
 
*Type: string
 
*Type: string
 
*Status: optional
 
*Status: optional
 
*Default: form
 
*Default: form
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=options
 
|sectionHeading=options
 
|anchor=options
 
|anchor=options
−
|Standalone=No
 
−
|ComingSoon=No
 
 
|alignment=Vertical
 
|alignment=Vertical
 
|structuredtext=*Description: The activity or behavior that you want to track.
 
|structuredtext=*Description: The activity or behavior that you want to track.
Line 98: Line 84:
 
{{!}}{{!}} 
 
{{!}}{{!}} 
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Revision as of 11:29, February 26, 2020

This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.

Learn how to use theforms:track method to capture when users complete web-based forms.

Description

The forms:track method tracks form submission and abandonment events. By default, forms tracking captures form data when a user submits or abandons a form.

  • Recorded form data includes the values of all input, select, and textarea fields.
  • Recorded form data excludes the values of hidden, submit, and password fields, along with any fields that contain any of the sensitive input strings.
Important
In order for Altocloud SDK forms tracking to capture form data, each input needs to have a properly defined name attribute.

See also Form Tracking API.

Signature

ac('forms:track', [selector], [options]);

Arguments

selector

  • Description: The CSS selector for the element or elements you want to track.
  • Type: string
  • Status: optional
  • Default: form

options

  • Description: The activity or behavior that you want to track.
  • Type: object
  • Status: optional
  • Default: {}
  • Properties:
Name Description Type Status Default Arguments
captureFormDataOnAbandon
boolean optional true  
captureFormDataOnSubmit
boolean optional true  
transform
function optional
formDataObject
traitsMapper   traitsMapper      
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Forms:track (2024-11-09 11:16:35)"
Comments or questions about this documentation? Contact us for support!