Difference between revisions of "ATC/Current/SDK/Pageview"
From Genesys Documentation
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
(Published) |
||
Line 2: | Line 2: | ||
|Standalone=No | |Standalone=No | ||
|DisplayName=pageview | |DisplayName=pageview | ||
− | |||
|TocName=pageview | |TocName=pageview | ||
+ | |Context=Learn how to use the <tt>pageview</tt> method to track when users view your webpages. | ||
+ | |Dimension=DevTracking | ||
|ComingSoon=No | |ComingSoon=No | ||
− | | | + | |Platform=PureConnect, GenesysCloud, GenesysEngage-cloud |
− | |||
|Section={{Section | |Section={{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 | |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 | |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 | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=pageOverrides | |sectionHeading=pageOverrides | ||
|anchor=pageOverrides | |anchor=pageOverrides | ||
− | |||
− | |||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=*Description: | + | |structuredtext=*'''Description:''' Sets custom page view location and title |
− | *Type: | + | *'''Type:''' Object |
− | *Status: | + | *'''Status:''' Optional |
− | *Properties: | + | *'''Properties:''' See the following table. |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
Line 64: | Line 53: | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
{{!}}} | {{!}}} | ||
− | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=customAttributes | |sectionHeading=customAttributes | ||
|anchor=customAttributes | |anchor=customAttributes | ||
− | |||
− | |||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=*Description: | + | |structuredtext=*'''Description:''' Adds extra information to <tt>pageview</tt> event |
− | *Type: | + | *'''Type:''' Object |
− | *Status: | + | *'''Status:''' Optional |
− | *Restrictions: | + | *'''Restrictions:''' Flat object with properties of type string, number, or Boolean |
− | |||
|Status=No | |Status=No | ||
}}{{Section | }}{{Section | ||
|sectionHeading=options | |sectionHeading=options | ||
|anchor=options | |anchor=options | ||
− | |||
− | |||
|alignment=Vertical | |alignment=Vertical | ||
− | |structuredtext=*Description: | + | |structuredtext=*'''Description:''' Use for more configuration |
− | *Type: | + | *'''Type:''' Object |
− | *Status: | + | *'''Status:''' Optional |
− | *Properties:<br /> | + | *'''Properties:''' See the following table.<br /> |
{{{!}} class="wikitable" | {{{!}} class="wikitable" | ||
Line 115: | Line 98: | ||
{{!}}{{!}}<br /> | {{!}}{{!}}<br /> | ||
{{!}}} | {{!}}} | ||
− | |||
|Status=No | |Status=No | ||
}} | }} | ||
}} | }} |
Revision as of 19:27, December 16, 2020
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 users view your webpages.
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: Flat object with properties of type string, number, or Boolean
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!