SDK Event Details
Here are the details and descriptions for each event JSON object in all versions of the Monetate SDK.
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. |