Difference between revisions of "ATC/Current/SDK/Pageview"
From Genesys Documentation
DannaShirley (talk | contribs) (Published) |
(Published) |
||
| (13 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
|Standalone=No | |Standalone=No | ||
|DisplayName=pageview | |DisplayName=pageview | ||
| − | |||
|TocName=pageview | |TocName=pageview | ||
| − | |Context= | + | |Context=Learn how to use the <tt>pageview</tt> method to track when visitors view your webpages. |
| + | |Dimension=DevTracking | ||
| + | |ComingSoon=No | ||
| + | |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 | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=The <tt>Pageview</tt> method tracks page views. | |structuredtext=The <tt>Pageview</tt> method tracks page views. | ||
| − | | | + | |Status=No |
}}{{Section | }}{{Section | ||
|sectionHeading=Signature | |sectionHeading=Signature | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | |||
|structuredtext=<tt>ac('pageview', [pageOverrides], [customAttributes], [options])</tt> | |structuredtext=<tt>ac('pageview', [pageOverrides], [customAttributes], [options])</tt> | ||
| − | | | + | |Status=No |
}}{{Section | }}{{Section | ||
|sectionHeading=Arguments | |sectionHeading=Arguments | ||
| − | |||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*[[#pageOverrides|pageOverrides]] | |
| − | |structuredtext=* [[#pageOverrides|pageOverrides]] | + | *[[#customAttributes|customAttributes]] |
| − | * [[#customAttributes|customAttributes]] | + | *[[#options|options]] |
| − | * [[#options|options]] | + | |Status=No |
| − | | | ||
}}{{Section | }}{{Section | ||
|sectionHeading=pageOverrides | |sectionHeading=pageOverrides | ||
| − | |||
|anchor=pageOverrides | |anchor=pageOverrides | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' Sets custom page view location and title | |
| − | |structuredtext=* Description: | + | *'''Type:''' Object |
| − | * Type: | + | *'''Status:''' Optional |
| − | * Status: | + | *'''Properties:''' See the following table. |
| − | * Properties: | + | |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
| Line 58: | Line 57: | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
{{!}}} | {{!}}} | ||
| − | | | + | |Status=No |
}}{{Section | }}{{Section | ||
|sectionHeading=customAttributes | |sectionHeading=customAttributes | ||
| − | |||
|anchor=customAttributes | |anchor=customAttributes | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' Adds extra information to <tt>pageview</tt> event | |
| − | |structuredtext=* Description: | + | *'''Type:''' Object |
| − | * Type: | + | *'''Status:''' Optional |
| − | * Status: | + | *'''Restrictions:''' Object with properties of type string, number, Boolean or customAttribute. See {{Link-SomewhereInThisVersion|manual=SDK|topic=customAttribute|display text=customAttributes}}. |
| − | * Restrictions: | + | |Status=No |
| − | | | ||
}}{{Section | }}{{Section | ||
|sectionHeading=options | |sectionHeading=options | ||
| − | |||
|anchor=options | |anchor=options | ||
|alignment=Vertical | |alignment=Vertical | ||
| − | + | |structuredtext=*'''Description:''' Use for more configuration | |
| − | |structuredtext=* Description: | + | *'''Type:''' Object |
| − | * Type: | + | *'''Status:''' Optional |
| − | * Status: | + | *'''Properties:''' See the following table.<br /> |
| − | * Properties:<br /> | + | |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
{{!}}- | {{!}}- | ||
| Line 89: | Line 85: | ||
{{!}}- | {{!}}- | ||
{{!}}{{!}}traitsMapper | {{!}}{{!}}traitsMapper | ||
| − | {{!}}{{!}}Used to map custom attributes to traits | + | {{!}}{{!}}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 106: | Line 102: | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
{{!}}} | {{!}}} | ||
| − | | | + | |Status=No |
}} | }} | ||
}} | }} | ||
Latest revision as of 10:17, July 7, 2022
This topic is part of the manual Journey JavaScript SDK for version Current of Genesys Predictive Engagement.
Learn how to use the pageview method to track when visitors view your webpages.
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 Pageview method tracks page views.
Signature
ac('pageview', [pageOverrides], [customAttributes], [options])
Arguments
pageOverrides
- Description: Sets custom page view location and title
- Type: Object
- Status: Optional
- Properties: See the following table.
| Name | Description | Type | Status | Default |
| location | Page URL | string | optional | |
| title | Page title | string | optional |
customAttributes
- Description: Adds extra information to pageview event
- Type: Object
- Status: Optional
- Restrictions: Object with properties of type string, number, Boolean or customAttribute. See customAttributes.
options
- Description: Use 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 |
Comments or questions about this documentation? Contact us for support!