SDK Event Details

here are the details and descriptions for each event json object in all versions of the monetate sdk monetate\ context\ ipaddress attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ ipaddress ) ipaddress string yes the ip address to send code example example of monetate\ context\ ipaddress event { "eventtype" "monetate\ context\ ipaddress", "ipaddress" "198 51 100 0" } monetate\ context\ pageview attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ pageview ) path string required if url isn't included the path portion of the url for the page viewed url string required if path isn't included the complete url for the page viewed pagetype string yes the type of page viewed (for example, "index" or "pdp" ) categories array optional categories to filter against only matching actions are evaluated breadcrumbs array optional breadcrumbs to filter against only matching actions are evaluated code example example of monetate\ context\ pageview event { "eventtype" "monetate\ context\ pageview", "url" "http //www monetate com/index html", "pagetype" "home", "categories" \["category"], "breadcrumbs" \["breadcrumb"] } monetate\ context\ cart attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ cart ) cartlines array\[cartline] yes the contents of the cart refer to sdk event details for details code example example of monetate\ context\ cart event { "eventtype" "monetate\ context\ cart", "cartlines" \[{ "sku" "sku1", "pid" "pid1", "quantity" 2, "currency" "usd", "value" "24 00" }] } monetate\ context\ addtocart attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ addtocart ) cartlines array\[cartline] yes the contents of the cart refer to sdk event details for details code example example of monetate\ context\ addtocart event { "eventtype" "monetate\ context\ cart", "cartlines" \[{ "sku" "sku1", "pid" "pid1", "quantity" 2, "currency" "usd", "value" "24 00" }] } monetate\ context\ purchase attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ purchase ) account string — the account id deprecated domain string — the account domain (for example, fifthlevelfashion com ) deprecated instance string — the type of instance (for example, p for production) deprecated purchaseid string yes the unique identifier for the purchase purchaselines array\[purchaseline] yes the contents of the purchase refer to sdk event details for details code exampl e example of monetate\ context\ purchase event { "eventtype" "monetate\ context\ purchase", "purchaseid" "1b2c3d", "purchaselines" \[{ "sku" "sku1", "pid" "pid1" "quantity" 2, "currency" "usd", "value" "24 00" }] } monetate\ context\ metadata attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ metadata ) metadata object \[language] yes additional custom data to send language string yes the language of the device or app code example example of monetate\ context\ metadata event { "eventtype" "monetate\ context\ metadata", "metadata" { "language" "en gb" } } monetate\ context\ productdetailview attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ productdetailview ) products array\[product] yes the list of products viewed on a product detail page refer to sdk event details for details code example example of monetate\ context\ productdetailview event { "eventtype" "monetate\ context\ productdetailview", "products" \[ { "productid" "product72", "sku" "product72 large green", }, { "productid" "product43", "sku" "product43 medium striped" } ] } monetate\ context\ productthumbnailview attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ productthumbnailview ) products array\[string] yes the list of product thumbnails viewed on a product list page refer to sdk event details for details code example example of monetate\ context\ productthumbnailview event { "eventtype" "monetate\ context\ productthumbnailview", "products" \["product72", "product43", "product42"] } monetate\ context\ coordinates attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ coordinates ) latitude string yes the device user's latitude coordinates in decimal degrees longitutde string yes the device user's longitude coordinates in decimal degrees code example example of monetate\ context\ coordinates event { "eventtype" "monetate\ context\ coordinates", "latitude" "49 566667", "longitude" "10 883333" } monetate\ context\ screensize attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ screensize ) height number yes the height of the device width number yes the width of the device code example example of monetate\ context\ screensize event { "eventtype" "monetate\ context\ screensize", "height" 762, "width" 1024 } monetate\ context\ customvariables attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ customvariables ) customvariables array\[customvariables] yes an array of custom variables refer to sdk event details /#customvariable for details code example example of monetate\ context\ customvariables event { "eventtype" "monetate\ context\ customvariables", "customvariables" \[{ "variable" "favoriteteam", "value" "blue hens" }] } monetate\ context\ useragent attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ useragent ) useragent string yes the user agent header value code example example of monetate\ context\ useragent event { "eventtype" "monetate\ context\ useragent", "useragent" "mozilla/5 0 (macintosh; u; intel mac os x; en) applewebkit/522 11 (khtml, like gecko) safari/3 0 2" } monetate\ context\ referrer attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ context\ referrer ) referrer string yes the referring url code example example of monetate\ context\ referrer event { "eventtype" "monetate\ context\ referrer", "referrer" "http //www example com" } monetate\ record\ pageevents attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ record\ pageevents ) pageevents array\[string] yes the array of page events code example example of monetate\ record\ pageevents event { "eventtype" "monetate\ record\ pageevents", "pageevents" \["myevent"] } monetate\ record\ impressions attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ record\ impressions ) impressionsids array\[string] yes the list of impression identifier strings code example example of monetate\ record\ impressions event { "eventtype" "monetate\ record\ impressions", "impressionids" \[ "3 ms4xlje1mtq4mdg5mdaumdawmdaw" ] } monetate\ record\ recclicks attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ record\ recclicks ) recclicks array\[string] yes the array of recommendation click tokens to record code example example of monetate\ record\ recclicks event { "eventtype" "monetate\ record\ recclicks", "recclicks" \["rt 1 xxx", "rt 1 yyy"] } monetate\ record\ recimpressions attribute required description eventtype string yes identifies the type of event use the name of this event ( monetate\ record\ recimpressions ) recimpressions array\[string] yes the array of recommendation impression tokens to be recorded code example example of monetate\ record\ recimpressions event { "eventtype" "monetate\ record\ recimpressions", "recimpressions" \["rt 1 xxx", "rt 1 yyy"] } cartline attribute required description sku string yes the unique identifier for the product pid string yes the parent identifier for a related set of skus quantity number yes the number of items in the cart currency string yes the currency of the purchase value value string yes the total value of the items in the specified currency purchaseline attribute required description sku string yes the unique identifier for the product pid string yes the parent identifier for a related set of skus quantity number yes the number of items purchased currency string yes the currency of the purchase value value string yes the total value of the items in the specified currency product attribute required description productid string yes the product id sku string optional the unique identifier for the product customvariable attribute required description variable string yes the name of the custom variable value string yes the value of the custom variable