Komo for Developers

Base Event Data

All Komo Events include the following fields, providing context about the page, user, and request.

Name	Type	Description	Optional
pageTitle	String	The title of the page.	False
hostName	String	The host name of the site.	False
pathName	String	The path of the page.	False
queryString	String	The query string of the page.	False
url	String	The full URL of the page.	False
referrer	String	The referrer URL.	False
languages	Array	User language preferences.	False
clientIp	String	The IP address of the client.	False
referer	String	The referring URL.	False
refererDomain	String	The domain of the referring URL.	False
userAgent	String	The user agent string.	False
clientRegion	String	The region of the client.	False
clientCity	String	The city of the client.	False
clientCityLatLong	String	The lat/long of the client city.	False
isBot	Boolean	Whether the client is a bot.	False

Depending on the Event category, the following fields are always included.

Name	Type	Description	Optional
siteId	String	The unique site ID	False
userId	String	The unique user ID	False
pageId	String	The unique page ID	False
pageSlug	String	The page slug	False

Name	Type	Description	Optional
siteId	String	The unique site ID	False
userId	String	The unique user ID	False
pageId	String	The unique page ID	False
pageSlug	String	The page slug	False
cardId	String	The unique card ID	False

Name	Type	Description	Optional
siteId	String	The unique site ID	False
userId	String	The unique user ID	False
surveyId	String	The unique survey ID	False
recipientId	String	The unique recipient ID	False

Note

Event-specific fields are documented on each event’s page. All events always include the Base Event Data and the relevant Core Context Fields above