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"
}
{
  "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"]
}
{
  "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 cartLine﻿
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"
  }]
}
{
  "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 cartLine﻿
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"
  }]
}
{
  "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 purchaseLine﻿ for details.
Code Example﻿
Example of monetate:context:Purchase Event
{
  "eventType": "monetate:context:Purchase",
  "purchaseId": "1b2c3d",
  "purchaseLines": [{
    "sku": "SKU1",
    "pid": "PID1"
    "quantity": 2,
    "currency": "USD",
    "value": "24.00"
  }]
}
{
  "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"
  }
}
{
  "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 product﻿ 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"
    }
  ]
}
{
  "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 product﻿ for details.
Code Example
Example of monetate:context:ProductThumbnailView Event
{
  "eventType": "monetate:context:ProductThumbnailView",
  "products": ["product72", "product43", "product42"]
}
{
  "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" 
}
{
  "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
}
{
  "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 ﻿customVariable﻿
for details.
Code Example
Example of monetate:context:CustomVariables Event
{
  "eventType": "monetate:context:CustomVariables",
  "customVariables": [{
    "variable": "favoriteTeam",
    "value": "Blue Hens"
  }]
}
{
  "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"
}
{
  "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"
}
{
  "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"]
}
{
  "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"
  ]
}
{
  "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"]
}
{
  "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"]
}
{
  "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.
﻿

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.

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.

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 cartLine for details.

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 cartLine for details.

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 purchaseLine for details.

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.

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 product for details.

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 product for details.

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.

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.

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 customVariable for details.

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.

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.

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.

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.

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.

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.

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.

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.

Attribute	Required	Description
productId: String	Yes	The product ID.
sku: String	Optional	The unique identifier for the product.

Attribute	Required	Description
variable: String	Yes	The name of the custom variable.
value: String	Yes	The value of the custom variable.

Updated 25 Nov 2024

SDK Event and Action Types

React Web Event Code Samples

SDK Event Details

monetate:context:ipAddress

Code Example

monetate:context:PageView

Code Example

monetate:context:Cart

Code Example

monetate:context:AddToCart

Code Example

monetate:context:Purchase

Code Example﻿

monetate:context:Metadata

Code Example

monetate:context:ProductDetailView

Code Example

monetate:context:ProductThumbnailView

Code Example

monetate:context:Coordinates

Code Example

monetate:context:ScreenSize

Code Example

monetate:context:CustomVariables

Code Example

monetate:context:UserAgent

Code Example

monetate:context:Referrer

Code Example

monetate:record:PageEvents

Code Example

monetate:record:Impressions

Code Example

monetate:record:RecClicks

Code Example

monetate:record:RecImpressions

Code Example

cartLine

purchaseLine

product

customVariable

Code Example