Visit Schema

From Genesys Documentation
Jump to: navigation, search
This topic is part of the manual Altocloud Administrator's Guide for version Current of Altocloud.

TBD

Base

Property Type Description Example Required Internal
id string ID of the visit "cjodpj0if0392jrjjjrj9302jrj230" Yes No
shortId string 4-6 digit temporary identifier of the visit. Useful to ask during an IVR session 91731 Yes No
account string Account ID assigned by Altocloud "cj3egmbvv0003wrncxxnf51hq" Yes No
business string Business ID assigned by Altocloud "cj3egkvy50001wrncw2ldh1z4" Yes No
createdAt string When visit was created (timestamp of the first activity in visit) "2017-01-11T16:00:53.885Z" Yes No
awayAt string Timestamp indicating after when the visitor should be considered as away "2017-01-11T16:00:53.885Z" Yes No
idleAt string Timestamp indicating after when the visitor should be considered as idle "2017-01-11T16:00:53.885Z" No No
lastActiveAt string Timestamp indicating when the visitor was last active on the page "2017-01-11T16:00:53.885Z" Yes No
customerCookieId string Cookie ID of a customer or visitor "ciz8agplj000ixync464aittt" Yes No
customerWebLogin string ID of a known (authenticated) customer on the Web "193719162" No No


Activity summary

Property Type Description Example Required Internal
lastPageUrl string URL of the last page visited "https://universal.com/products" No No
lastPageTitle string Title of the last page visited Insurance Products No No
pageviewCount number Number of pages viewed within the web visit 3 Yes No
searchTerms string[] List of search terms used within the web visit ["racing car", "opening hours"] No No


Personas and outcomes

Property Type Description Example Required Internal
personas string[] List of personas IDs that the customer was assigned to due to activities performed within the web visit ["cj3e1gmy4wrncjhmxxhxx"] No No
outcomes string[] List of outcome IDs achieved due to activities performed within the web visit ["cj3egn6yfn31ccwdyxl4x"] No No
outcomes OutcomeScore[] List of outcome scores related to the web visit [{"id": "...", "p": 0.4, "maxp": 0.71}] No No


Referrer

Property Type Description Example Required Internal
refDomain string URL domain universal.com No No
refHostname string Referrer host/hostname "app.universal.com" No No
refKeywords string Referrer page keywords "auto insurance" No No
refPathname string Path to referrer page "/auto" No No
refQuery string Referrer query string "license=YGF6Z&zipCode=KDCCB" No No


refUrl string Referrer page URL "https://app.universal.com/auto#quote-details" No No


Marketing campaign

Property Type Description Example Required Internal
mktCampaignContent string Differentiate ads or links that point to the same URL "logolink" or "textlink" No No
mktCampaignMedium string Identify a medium such as email or cost-per-click "CPC" No No
mktCampaignName string Identify a specific product promotion or strategic campaign "320banner" No No
mktCampaignSource string identify a search engine, newsletter name, or other source "Google" No No
mktCampaignTerm string Note the keywords for this ad "running+shoes" No No


User Agent

Property Type Description Example Required Internal
userAgent string User agent string "Mozilla\/5.0 (Windows NT 6.1; WOW64) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/37.0.2062.120 Safari\/537.36" No No
browserFamily string Browser family "Chrome" No No
browserVersion number Browser major version 37.0 No No
browserLang string Language the browser is set to "en-GB" No No
browserViewHeight number Browser's viewport height 1000 No No
browserViewWidth number Browser's viewport width 1000 No No
browserFeaturesWebrtc boolean Whether WebRTC is supported true No No


Device and operating system

Property Type Description Example Required Internal
deviceType string Device type "other" No No
deviceCategory string Device category "Mobile" No No
deviceIsMobile boolean Flag that is true for mobile devices true No No
deviceScreenHeight number Screen height 1024 No No
deviceScreenWidth number Screen width 1900 No No
deviceFingerprint string Optional device fingerprint generated based on the device data ....? No No
osFamily string Operating system family "Mac Os X" No No
osVersion number Operating system version 10.12 No No


Location

Property Type Description Example Required Internal
geoCountry string 2-letter country code (CCA2) "IE" No No
geoCountryName string Country name "Ireland" No No
geoLatitude number Numerical location latitude 53.3389 No No
geoLongitude number Numerical location longitude -6.2595 No No
geoLocality string Locality (city/town) "Dublin" No No
geoRegion string ISO-3166-2 region code "IE-G" No No
geoRegionName string Name of region "Galway" No No
geoSource string The source that was used to determine the location information "ip" No No
geoTimezone string Timezone of the visitor "Europe/London" No No
geoPostalCode string Also known as postcode or zipcode "F9YCP5" No No


IP address

Property Type Description Example Required Internal
ip string IP address of the visitor "92.231.54.234" No No
ipOrganization string Organization name derived from the IP "Amazon.com" No No