Difference between revisions of "ATC/Current/SDK/Record"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
|||
| Line 9: | Line 9: | ||
|Section={{Section | |Section={{Section | ||
|sectionHeading=Description | |sectionHeading=Description | ||
| − | | | + | |Standalone=No |
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=The <tt>record</tt> method records custom website events. | |structuredtext=The <tt>record</tt> method records custom website events. | ||
|fullwidth=No | |fullwidth=No | ||
| Line 17: | Line 17: | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
| − | | | + | |Standalone=No |
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=<tt>ac('record', eventName, [customAttributes], [options])</tt> | |structuredtext=<tt>ac('record', eventName, [customAttributes], [options])</tt> | ||
|fullwidth=No | |fullwidth=No | ||
| Line 25: | Line 25: | ||
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| − | | | + | |Standalone=No |
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=*[[#eventName|eventName]] | |structuredtext=*[[#eventName|eventName]] | ||
*[[#customAttributes|customAttributes]] | *[[#customAttributes|customAttributes]] | ||
| Line 35: | Line 35: | ||
}}{{Section | }}{{Section | ||
|sectionHeading=eventName | |sectionHeading=eventName | ||
| − | |||
|anchor=eventName | |anchor=eventName | ||
| + | |Standalone=No | ||
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=*Description: name of the custom event | |structuredtext=*Description: name of the custom event | ||
*Type: string | *Type: string | ||
| Line 46: | Line 46: | ||
}}{{Section | }}{{Section | ||
|sectionHeading=customAttributes | |sectionHeading=customAttributes | ||
| − | |||
|anchor=customAttributes | |anchor=customAttributes | ||
| + | |Standalone=No | ||
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=*Description: adds extra information to <tt>pageview</tt> event | |structuredtext=*Description: adds extra information to <tt>pageview</tt> event | ||
*Type: object | *Type: object | ||
| Line 58: | Line 58: | ||
}}{{Section | }}{{Section | ||
|sectionHeading=options | |sectionHeading=options | ||
| − | | | + | |Standalone=No |
| + | |ComingSoon=No | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=*Description: Used for additional configuration | |structuredtext=*Description: Used for additional configuration | ||
*Type: object | *Type: object | ||
Revision as of 13:34, January 17, 2020
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.
Description
The record method records custom website events.
Signature
ac('record', eventName, [customAttributes], [options])
Arguments
eventName
- Description: name of the custom event
- Type: string
- Status: required
customAttributes
- Description: adds extra information to pageview event
- Type: object
- Status: optional
- Restrictions: a flat object with properties of type string, number, or boolean
options
- Description: Used for additional configuration
- Type: object
- Status: optional
- Properties:
| 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 |
Comments or questions about this documentation? Contact us for support!