SDK Event Details
Here are the details and descriptions for each event JSON object in all versions of the Monetate SDK.
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
ipAddress: String | The IP address to send. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
path: String | The path portion of the URL for the page viewed. Optional if url is included. |
url: String | The complete URL for the page viewed. Optional if path is specified. |
pageType: String | The type of page viewed (for example, index or PDP). |
categories: Array | Categories to filter against. Only matching actions are evaluated. |
breadcrumbs: Array | Breadcrumbs to filter against. Only matching actions are evaluated. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
cartLines: Array[cartLine] | The contents of the cart. Refer to cartLine for details. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
cartLines: Array[cartLine] | The contents of the cart. Refer to cartLine for details. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
account: String | The account ID. |
domain: String | The account domain. |
instance: String | The type of instance. |
purchaseId: String | The unique identifier for the purchase. |
purchaseLines: Array[purchaseLine] | The contents of the purchase. Refer to purchaseLine for details. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
metadata: Object | Additional custom data to send. |
language: String | The language of the device or app. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
products: Array[product] | The list of products to display. Refer to product for details. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
products: Array[product] | The list of products to display. Refer to product for details. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
latitude: String | The latitude of the user. |
longitutde: String | The longitude of the user. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
height: Number | The height of the device. |
width: Number | The width of the device. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
customVariables: Array[CustomVariables] | An array of custom variables. |
variable: String | The name of the custom variable. |
value: String | The value of the custom variable. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
userAgent: String | The User-Agent header value. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
referrer: String | The referring URL. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
closedSession: Object | The closed session object retrieved from the closed session stream. |
version: String | The version of the closed session object. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
pageEvents: Array[String] | The array of page events. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
impressionsIds: Array[String] | The list of impression identifier strings. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
recClicks: Array[String] | The array of recommendation click tokens to record. |
Attribute | Description |
eventType: String | Identifies the type of event. Use the name of this event. |
recImpressions: Array[String] | The array of recommendation impression tokens to be recorded. |
Attribute | Description |
sku: String | The unique identifier for the product. |
pid: String | The parent identifier for a related set of SKUs. |
quantity: Number | The number of items in the cart. |
currency: String | The currency type of the purchase value. |
value: String | The total value of the items in the specified currency. |
Attribute | Description |
sku: String | The unique identifier for the product. |
pid: String | The parent identifier for a related set of SKUs. |
quantity: Number | The number of items in the cart. |
currency: String | The currency type of the purchase value. |
value: String | The total value of the items in the specified currency. |
Attribute | Description |
productId: String | The product ID. |
sku: String | The unique identifier for the product. |