Difference between revisions of "ATC/Current/SDK/Record"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(17 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
|Standalone=No
 
|Standalone=No
 
|DisplayName=record
 
|DisplayName=record
−
|Platform=PureEngage, PureConnect, PureCloud
 
 
|TocName=record
 
|TocName=record
 +
|Context=Learn how to use the <tt>record</tt> method to capture website events.
 +
|Dimension=DevTracking
 
|ComingSoon=No
 
|ComingSoon=No
−
|Context=The <tt>record</tt> method records custom website events.
+
|Platform=PureConnect, GenesysCloud, GenesysEngage-cloud
 
|Section={{Section
 
|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 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
 
|sectionHeading=Description
 
|sectionHeading=Description
−
|Type=Structured
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
 
 
|structuredtext=The <tt>record</tt> method records custom website events.
 
|structuredtext=The <tt>record</tt> method records custom website events.
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Signature
 
|sectionHeading=Signature
−
|Type=Structured
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
 
 
|structuredtext=<tt>ac('record', eventName, [customAttributes], [options])</tt>
 
|structuredtext=<tt>ac('record', eventName, [customAttributes], [options])</tt>
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Arguments
 
|sectionHeading=Arguments
−
|Type=Structured
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*[[#eventName|eventName]]
−
|structuredtext=* [[#eventName|eventName]]
+
*[[#customAttributes|customAttributes]]
−
* [[#customAttributes|customAttributes]]
+
*[[#options|options]]
−
* [[#options|options]]
 
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=eventName
 
|sectionHeading=eventName
−
|Type=Structured
 
 
|anchor=eventName
 
|anchor=eventName
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' Name of the custom event
−
|structuredtext=* Description: name of the custom event
+
*'''Type:''' String
−
* Type: string
+
*'''Status:''' Required
−
* Status: required
+
*'''Restrictions''': See {{Link-SomewhereInThisVersion|manual=SDK|topic=Types_of_tracked_data|anchor=Guidelines|display text=Guidelines for custom event names}}.
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=customAttributes
 
|sectionHeading=customAttributes
−
|Type=Structured
 
 
|anchor=customAttributes
 
|anchor=customAttributes
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' Adds extra information to <code>pageview</code> event
−
|structuredtext=* Description: adds extra information to <tt>pageview</tt> event
+
*'''Type:''' Object
−
* Type: object
+
*'''Status:''' Optional
−
* Status: optional
+
*'''Restrictions:''' Flat object with properties of type string, number, Boolean, or customAttribute
−
* Restrictions: a flat object with properties of type string, number, or boolean
+
 
−
|fullwidth=No
+
====Example====
 +
<code>ac('record', 'product_added', { price: 15.99, code: 'CDE-123', name: 'Product', hasBatteries: false });</code>
 +
 
 +
Additionally, define the datatype for the attribute to define the value better.
 +
====Example====
 +
<code>ac('record', 'product_added', { price: {datatype: 'integer' value: 15, name: {datatype: 'string' value: 'Product'}‎​}​​});​ </code>
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=customAttributes for outcome value tracker
 +
|anchor=outcome_value
 +
|alignment=Vertical
 +
|structuredtext=To derive the value of an outcome, create an event that comprises an associated value field. Then, using this event and the value field (within the same event), track the value of {{Link-SomewhereInThisVersion|manual=AdminGuide|topic=Manage_outcomes|display text=the outcome you created.}} 
 +
 
 +
For example, the following event tracks the products added with the value, price''.'' When you create an outcome using this event, the products added along with their value is tracked as part of the outcome. 
 +
 
 +
*'''Description:''' Adds extra information to <code>pageview</code> event
 +
*'''Type:''' Object
 +
*'''Status:''' Optional
 +
*'''Restrictions:''' Flat object with properties of type string, number, or Boolean
 +
 
 +
====Example====
 +
<code>ac('record', 'product_added', { price: 15, code: 'CDE-123', name: 'Product', hasBatteries: false });</code>
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
 
|sectionHeading=options
 
|sectionHeading=options
−
|Type=Structured
 
 
|alignment=Vertical
 
|alignment=Vertical
−
|gif=No
+
|structuredtext=*'''Description:''' Used for more configuration
−
|structuredtext=* Description: Used for additional configuration
+
*'''Type:''' Object
−
* Type: object
+
*'''Status:''' Optional
−
* Status: optional
+
*'''Properties:''' See the following table.
−
* Properties:
+
 
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}-
 
{{!}}-
Line 73: Line 86:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}traitsMapper
 
{{!}}{{!}}traitsMapper
−
{{!}}{{!}}Used to map custom attributes to traits. For more information, see{{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits Mapper.}}
+
{{!}}{{!}}Used to map custom attributes to traits. For more information, see {{Link-SomewhereInThisVersion|manual=SDK|topic=Traits_mapper|display text=Traits Mapper.}}
 
{{!}}{{!}}traitsMapper
 
{{!}}{{!}}traitsMapper
 
{{!}}{{!}}<br />
 
{{!}}{{!}}<br />
Line 79: Line 92:
 
{{!}}-
 
{{!}}-
 
{{!}}{{!}}callback
 
{{!}}{{!}}callback
−
{{!}}{{!}}called once beacon is sent
+
{{!}}{{!}}Called once beacon is sent
 
{{!}}{{!}}function
 
{{!}}{{!}}function
 
{{!}}{{!}}optional
 
{{!}}{{!}}optional
Line 90: Line 103:
 
{{!}}{{!}}<br />
 
{{!}}{{!}}<br />
 
{{!}}}
 
{{!}}}
−
|fullwidth=No
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 11:30, February 7, 2024

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

Learn how to use the record method to capture website events.

Important
This article only applies to customers using web chat. If you are a Genesys Cloud CX customer, we encourage you to use the new web messaging feature to replace web chat.

Description

The record method records custom website events.

Signature

ac('record', eventName, [customAttributes], [options])

Arguments

eventName

customAttributes

  • Description: Adds extra information to pageview event
  • Type: Object
  • Status: Optional
  • Restrictions: Flat object with properties of type string, number, Boolean, or customAttribute

Example

ac('record', 'product_added', { price: 15.99, code: 'CDE-123', name: 'Product', hasBatteries: false });

Additionally, define the datatype for the attribute to define the value better.

Example

ac('record', 'product_added', { price: {datatype: 'integer' value: 15, name: {datatype: 'string' value: 'Product'}‎​}​​});​ 

customAttributes for outcome value tracker

To derive the value of an outcome, create an event that comprises an associated value field. Then, using this event and the value field (within the same event), track the value of the outcome you created.

For example, the following event tracks the products added with the value, price. When you create an outcome using this event, the products added along with their value is tracked as part of the outcome.

  • Description: Adds extra information to pageview event
  • Type: Object
  • Status: Optional
  • Restrictions: Flat object with properties of type string, number, or Boolean

Example

ac('record', 'product_added', { price: 15, code: 'CDE-123', name: 'Product', hasBatteries: false });

options

  • Description: Used for more configuration
  • Type: Object
  • Status: Optional
  • Properties: See the following table.
Name Description Type Status Default
traitsMapper Used to map custom attributes to traits. For more information, see Traits Mapper. traitsMapper

callback Called once beacon is sent function optional
callbackTimeout ms to wait for beacon to send number optional
Retrieved from "https://all.docs.genesys.com/ATC/Current/SDK/Record (2025-07-14 17:44:51)"
Comments or questions about this documentation? Contact us for support!