Web events

Acoustic Exchange has identified and defined recognized events that typically happen during interactions that occur while customers use web-based systems. Web events usually describe interactions that occur during visits to a web site. As an endpoint publisher, call https://api-exchange-us-1.goacoustic.com/v1/event to publish the event. The following example illustrates a typical JSON payload for the API call. This example is based on the Cart Abandonment event.

POST v1/event
{  
  “channel” : “web”, 
  “identifiers” : [            
    {
    “name” : “cookieId”,
    “value” : “455739626”
    }
    ],
  “events” : [
    { 
    “code” : “ibmcartAbandonment”, 
    “timestamp” : “2015-09-28T20:15:12Z”, 
    “attributes” : [
      {
      “name” : “eventName”,            
      “value” : “Aggregate Cart Abandonment”,  
      “type” : “string” 
      } 
      {
      “name” : “interactionId”,            
      “value” : “1238953”,  
      “type” : “string” 
      }      
      {
      “name” : “quantity”,            
      “value” : “4”,  
      “type” : “integer” 
      }   
      {
      “name” : “currency”,            
      “value” : “euro”,  
      “type” : “string” 
      }  
      {
      “name” : “orderTotal”,            
      “value” : “525.00”,  
      “type” : “integer” 
      } 
      ]
    }   
  ]
}

Cart purchase - aggregate

Information that describes a cart of items that an individual purchased through a web site. This event contains characteristics for the entire purchase.

Event Code: ibmcartPurchase
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Aggregate Purchase

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the event to provide context for the event.

orderID

string

5678

Identifies a specific purchase.

Yes

interactionId

string

12345

Unique identifier for a visit. Sometimes called a session ID.

For example, if a cookieId identifies a visitor, the
interactionId identifies a visit by that person. One person can generate multiple visits, which are distinguished by multiple interactionIds

Yes

quantity

integer

5

Total number of individual items in the cart.

Yes

productList

string

Comma delimited list of product IDs

The product IDs of the items purchased separated by a comma.

orderSubTotal

integer

777.50

Order amount before sales, discounts, tax, and any other charges.

orderShipping

integer

25.00

If populated, it will show the cost of shipping added to the order total.

orderDiscount

integer

150.00

Amount that is deducted from order sub total.

orderPromo

string

AS678

Promotional code/offer used at checkout.

orderTax

integer

31.28

Tax amount on the total cart order.

orderTotal

integer

625.50

Total order amount. The amount should not include shipping, but might include sales or discounts.

Yes

currency

string

USD

Type of currency.

shippingType

string

Priority

Shipping method select by customer.

Cart purchase – item

Information to describe an item that is purchased through a web site.

Event code: ibmcartPurchaseItem
Event attributes

Attribute Name

Data Type

Example

Description

Required

basePrice

number

75.00

The price of the item purchased.

Yes

cartTotal

number

625.50

Total order amount.

Should not include shipping, but might include sales or discounts. This is the same amount as in
ibmcartPurchase.

Yes

category

string

Desks

Allows grouping of products into categories. For example,
Desks

Yes

eventName

string

Purchase item

Name of the event as it appears in the Exchange user interface.

Yes

interactionId

integer

12345

Unique identifier for a visit. Sometimes called a session ID.

Yes

orderID

string

5678

Identifies a specific purchase.

Yes

productID

string

The product ID of the item purchased

Yes

productName

string

Student Desk

The product name of the item purchased.

quantity

number

5

Can be more than 1 if more than one of the same product is purchased.

Yes

color

string

blue

Product color.

currency

string

EUR

Type of currency.

description

string

Description of the event to provide context for the event.

imageURL

URL

URL for the product image.

offerCode

string

12345

Offer code used at checkout.

orderDiscount

number

15.00

Discounted amount from order sub total.

productDesc

string

Detailed description of the product.

productUrl

URL

URL for additional product information.

size

string

12

The size of the item.

Cart abandonment – aggregate

Information that describes an abandoned cart. If the entire cart is abandoned, then the cart is abandoned. There can be no items purchased in the session (interaction).

Event code – ibmcartAbandonment
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

Aggregate Cart Abandonment

Name of the event as it appears in the Acoustic Exchange user interface.

Yes

description

string

Description of the even to provide context for the event.

interactionId

integer

12345

Unique identifier for a visit. Sometimes called a session ID.

Yes

quantity

number

10

This is the total number of items abandoned in the cart.

Yes

productList

string

The product IDs of the abandoned items, separated by a comma.

currency

string

EUR

Type of currency.

orderTotal

number

500.00

Total amount (based on basePrice of each item abandoned) of the cart.

Yes

Cart abandonment – item

Information that describes an individual item in an abandoned cart.

Event code: ibmcartAbandonmentItem
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Abandoned Item

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the event to provide context for the event.

interactionId

interger

12345

Unique identifier for a visit. Sometimes called a session ID.

Yes

productId

string

The product ID of the abandoned item.

Yes

productName

string

Leather High-Back Office Chair

The product name of the abandoned item.

Yes

productDesc

string

Detailed description of the product.

productURL

URL

URL for additional product information.

imageUrl

URL

URL for the product image.

color

string

brown

Product color.

size

string

12

The size of the item.

category

string

Office furniture

Allows grouping of products into categories. For example, Base Desk, Computer Desk and Office Desk could roll up under Office furniture.

Yes

quantity

number

5

Can be more than 1 if more than one of the same product is abandoned.

Yes

currency

string

EUR

Type of currency.

basePrice

number

175.00

The price of the abandoned item.

Yes

cartTotal

number

3250.50

Total amount (based on basePrice of each item abandoned) of the cart.

Yes

Conversion

Information that describes a conversion event.

Event code: ibmconversion
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Complete Conversion

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event. Allow Acoustic Exchange users to understand the event context.

interactionId

string

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventId

string

Satisfaction Survey

Unique ID to identify the type of event and enable lookup in the system.

Yes

actionType

1=Initiated

2=Completed

string

2

A complete conversion is a conversion 1 with a corresponding conversion 2, or conversion 2 only.

points

string

Each event id (each unique conversion event tracked) can have its own point value.

category

string

Surveys

Group events (eventNames) into categories. Example: create different types of credit apps (MasterCard, Visa) within a category: Credit Applications

Yes

Abandoned conversion or non-conversion

Information that describes an abandoned conversion event.

Event code: ibmabandonedConversion
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Incomplete Conversion

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event. Allows Exchange users to understand the event context.

interactionId

string

<12345>

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventId

string

Credit application submission

Unique ID to identify the type of event and enable lookup in the system.

Yes

actionType

1=Initiated

2=Completed

string

1

A complete conversion is a conversion 1 with a corresponding conversion 2, or conversion 2 only.

points

string

<6789>

Each event id (each unique conversion event tracked) can have its own point value.

category

string

Credit application

Group events (eventNames) into categories. Example: create different types of credit apps (MasterCard, Visa) within a category: Credit Applications

Yes

Searched site

Information that describes what happens as an individual searched a web site. A variation of a page view.

Event code: ibmsearchedSite
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Searched Site

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event to allow the user to better understand the context of the event.

interactionId

string

<12345>

Identifies a site visit. Example: a cookie ID that identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple
visits. Also called a session ID.

Yes

searchType

string

OnSite

Type of search. Example: For Acoustic Digital Analytics, the type is always On Site.

Yes

searchTerms

string

Lamps

Term entered by visitor when they performed the search.

Yes

siteName

string

Name or domain of the site that was searched.

Yes

pageURL

string

URL of the landing page after the search performed.

pageID

string

Search Unsuccessful

Page Name of the landing page.

Yes

Product view

Information that describes a view of a web page.

Event code: ibmproductView
Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Product View

Name of the event as it appears in the Acoustic Exchange user interface.

Yes

description

string

Description of the published event. Allow Exchange users to understand the event context.

interactionId

string

12345

Identifies a site visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

productID

string

6789

The product ID of the item purchased.

Yes

productName

string

Leather High-Back Office Chair

The product name of the item purchased

Yes

productDesc

string

Description of the

productUrl

string

URL for product information.

imageUrl

string

URL for product image.

color

string

Red

Product color.

size

string

12

Product size.

category

string

Office Chairs

Allows the grouping of products into categories. For example, Student Desks, Computer Desks, and Office Desks can be grouped into the Desk category.

Yes

Browse abandonment – aggregate

Information that describes what occurs when a customer abandons a web page after viewing multiple items.

Event code: ibmbrowseAbandonment
Note: Event attributes for ibmbrowseAbandonment and ibmbrowseAbandonmentItem must be in the same JSON payload.

Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Aggregate Browse Abandonment

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event. Allow Exchange users to understand the event context.

interactionId

string

3.21005E+18

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

quantity

string

3

The total number of items browsed.

Yes

productList

string

Comma delimited list of product IDs

The product IDs of the abandoned items, separated by commas.

Yes

Browse abandonment – item

Information that describes what occurs when a customer abandons a web page after viewing a single item.

Event code: ibmbrowseAbandonmentItem
Note: Event attributes for ibmbrowseAbandonment and ibmbrowseAbandonmentItem must be in the same JSON payload.

Event attributes

Attribute Name

Data Type

Example

Description

Required

eventName

string

Abandoned Item

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event. Allow Exchange users to understand the event context.

interactionId

string

3.21005E+18

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

productID

string

The product ID of the abandoned item.

productName

string

Leather High-Back Office Chair

The product name of the abandoned item.

Yes

productDesc

string

Detailed description of the product.

productUrl

URL

URL for additional product information.

imageURL

URL

<product specific<

URL for the product image.

color

string

brown

Product color.

size

string

12

The size of them.

category

string

Office furniture

Allows grouping of products into categories. For example, Base Desk, Computer Desk and Office Desk could roll up under Office furniture.

Yes

currency

string

EUR

Type of currency.

basePrice

number

175.00

The price of abandoned item.

Yes

Video paused

Information that describes a video on a website being paused by a customer.

Event code: ibmelementVideoPaused
Event attributes

Attribute Name

Data Type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

WEB

The channel in which the event occurred.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

8.42225E+22

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:10Z

The date and time when the event occurred.

Yes

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

versionOS

string

10.10

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

The browser on the device.

interactionId

string

3801817

Identifies a website visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Paused Video

Name of the intra-page event as it appears in the Acoustic Exchange user interface.

Yes

elementId

string

ELEMID147941

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

videotimestamp

string

425

The amount of time a video was played before it was paused or stopped.

Yes

videoTotalLength

string

573

The total length of the video being viewed by the customer.

Yes

Video completed

Information that describes a video on a website being watched to completion by a customer.

Event code: ibmelementVideoCompleted
Event attributes

Attribute Name

Data Type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

MOBILE

The channel in which the event occurs.

Yes

subChannel

string

MOBILE

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

1653508431

The mean by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:09Z

The data and time when an event occurred.

Yes

deviceType

string

MOBILEPHONE

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IPHONE

The model of the device.

OS

string

iOS

The OS of the device.

versionOS

string

9

The version of the device.

browserName

string

SAFARI

The browser used on the device.

interactionId

string

7021070964113409727

Identifies a website visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Completed Video

Name of the intra-page event as it appears in the Acoustic Exchange user interface.

Yes

elementId

string

ELEMID273780

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

videotimestamp

string

871

The amount of time a video was played before it was paused or stopped.

Yes

videoTotalLength

string

902

The total length of the video being viewed by the customer.

Yes

Video launched

Information that describes a video related to a product or brand being launched by a customer.

Event code: ibmelementVideoLaunched
Event attributes

Attribute Name

Data Type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

WEB

The channel in which the event occurs.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where the event occurred.

Yes

cookieId

string

3508431

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:10Z

The date and time when an event occurred.

Yes

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

versionOS

string

10.10

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

The browser used on the device.

interactionId

string

3801817

Identifies a website visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Paused Video

Name of the intra-page event as it appears in the Exchange user interface.

Yes

elementId

string

ELEMID147941

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

videotimestamp

string

425

The amount of time a video was played before it was paused or stopped.

Yes

videoTotalLenght

string

573

The total length of the video being viewed by the customer.

Yes

Video completed

Information that describes a video on a website being watched to completion by a customer.

Event code: ibmelementVideoCompleted
Event attributes

Attribute Name

Data Type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

MOBILE

The channel in which the event occurs.

Yes

subChannel

string

Mobile

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

1653508431

The mean by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:09Z

The data and time when an event occurred.

Yes

deviceType

string

MOBILEPHONE

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IPHONE

The model of the device.

OS

string

iOS

The OS of the device.

versionOS

string

9

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

Browser used on the device.

interactionId

string

9.1

Identifies a website visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Completed Video

Name of the intra-page event as it appears in the EX- user interface.

Yes

elementId

string

ELEMID273780

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

videotimestamp

string

871

The amount of time a video was played before it was paused or stopped.

Yes

videoTotalLength

string

902

The total length of the video being viewed by the customer.

Yes

Video launched

Information that describes a video related to a product or brand being launched by a customer.

Event code: ibmelementVideoLaunched
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

WEB

The channel in which the event occurs.

Yes

subChannel

string

WEB

A more d

Yes

cookieId

string

3508431

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:09Z

The date and time when an event occurred.

Yes

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

browserName

string

10.10

The version of the device.

browserVersion

string

9.1

Browser used on the device.

interactionId

string

3409727

Identifies a website visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Completed Video

Name of the intra-page event as it appears in the Exchange user interface.

Yes

elementId

string

ELEMID273780

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

videotimestamp

string

871

The amount of time a video was played before it was paused or stopped.

Yes

videoTotalLength

string

902

The total length of the video being viewed by the customer.

Yes

Video played

Information that describes video being played by a customer.

Event code: ibmelementVideoPlayed
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider

Yes

channel

string

WEB

The channel in which the event occurred.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

8.42225E+22

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:10Z

The date and time when an event occurred.

Yes

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

versionOS

string

10.10

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

Browser used on the device.

interactionId

string

3801817

Identifies a website visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Paused Video

Name of the intra-page event as it appears in the Acoustic Exchange user interface.

Yes

elementId

string

ELEMID147941

The means used to identify an element.

Yes

elementCategory

string

VIDEO

Allows grouping events into categories.

Yes

Form error

Information that describes an error on a web form, such as a missing field in a check out or registration.

Event code: ibmelementFormError
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

WEB

The channel in which the event occurs.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

7663299

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:38:10Z

The date and time when an event occurred.

Yes

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

versionOS

string

10.10

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

Browser used on the device.

interactionId

string

22820

Identifies a web site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Form Error

Name of the intra-page event as it appears in the Acoustic Exchange user interface.

Yes

elementID

string

ELEMID58764

The means used to identify an element.

Yes

elementCategory

string

ERROR

Allows grouping events into categories.

Yes

Entry page

Information that describes a customer visiting an entry page.

Event code: ibmpageviewEntryPage
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint.

Yes

channel

string

WEB

The channel in which the event occurs.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

7663299

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:00:39Z

The date and time when an event occurred.

Yes

deviceType

string

MOBILEPHONE

The type of device used to capture a customer event.

vendor

string

BLACKBERRY

The vendor of the device.

model

string

7730

The model of the device.

OS

string

RIMOS

The OS of the device.

versionOS

string

3.7.0

The version of the device.

browserName

string

UP.BROWSER

The browser used on the device.

browserVersion

string

10.3

Browser used on the device.

interactionId

string

207247192

Identifies a website visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Session Entry Page

Name of the intra-page event as it appears in the Exchange user interface.

Yes

category

string

HOME PAGE

Allows grouping of pages into categories. For example, the Welcome, About Us, and Contact Us pages could roll up under Home Page.

Yes

pageId

string

HOME PAGE

Page name of the enty

Yes

pageURL

string

The URL of the entry page.

Yes

referralURL

The referral URL for the entry page.

Yes

Product page action

Information that describes an action carried out by a customer on a product page. The action can be defined by an administrator.

Event code: ibmelementProductPageAction
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the endpoint provider.

Yes

channel

string

WEB

The channel in which the event occurs.

Yes

subChannel

string

WEB

A more granular descriptor of the channel where an event occurred.

Yes

cookieId

string

565432

The means by which the visitor is tracked during a visit to a website.

Yes

timestamp

string

2019-02-11T05:28:16Z

The date and time when an event occurred.

deviceType

string

DESKTOP

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IMAC

The model of the device.

OS

string

OSX

The OS of the device.

versionOS

string

10.10

The version of the device.

browserName

string

SAFARI

The browser used on the device.

browserVersion

string

9.1

Browser used on the device.

interactionId

string

1845705

Identifies a website visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

eventName

string

Product Page Action

Name of the intra-page event as it appears in the Acoustic Exchange user interface.

Yes

elementId

string

ELEMID717261

The means used to identify an element.

elementCategory

string

ERROR

The means used to identify an element.

Yes

Element

Information that describes some intra-page action on a web page.

Event code: ibmelement
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Acoustic

The name of the Exchange endpoint provider.

channel

string

MOBILE

The channel in which the event occurs.

SubChannel

string

MOBILE

The more granular descriptor of the channel where an event occurred.

cookieID

string

The means by which the a visitor is tracked during a visit to a website.

timestamp

string

Date and time when an event occurred.

deviceType

string

The type of device used to capture a customer event.

vendor

string

The vendor of the device.

model

string

The model of the device.

OS

string

IOS

The OS of the device.

versionOS

string

4

The version of the device.

BrowserName

string

SAFARI

The browser used on the device.

browserVersion

string

3

Browser version used on the device.

eventName

string

Opened store locator

Name of the intra-page event as it appears in the Exchange user interface.

interactionId

string

3.21005E+18

Identify a web site visit. Example: a cookie ID identifies the visitor. The
interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

description

string

Looked for a store location on a mobile device.

Description of the intra-page action event. Allow Exchange users to understand the event context.

elementId

string

ELEMID597964

The means used to identify an element.

elementCategory

string

MOBILE

Allows grouping events into categories.

Element read review

Information that describes what happened when a web site visitor read a product review on a web page.

Event code: ibmelementReadReview
Event attributes

Attribute name

Data type

Example

Description

Required

provider

string

Exchange

The name of the Exchange endpoint provider.

channel

string

MOBILE

The channel in which the event occurs.

SubChannel

string

MOBILE

A more granular descriptor of the channel where an event occurred.

cookieID

string

8.42225E+22

The means by which the visitor is tracked during a visit to a website.

timestamp

string

2019-02-11T05

Date and time when an event occurred.

deviceType

string

MOBILEPHONE

The type of device used to capture a customer event.

vendor

string

APPLE

The vendor of the device.

model

string

IPHONE

The model of the device.

OS

string

IOS

The OS of the device.

versionOS

string

4

The version of the device.

browserName

string

SAFARI

The browser used on the device.

eventName

string

3

Browser version used on the device.

interactionId

string

3.21005E+18

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

description

string

Read a customer review no a mobile device.

Description of the published event. Allow Exchange users to understand the event context.

elementId

string

ELEMID597964

The means used to identify an element.

elementCategory

string

MOBILE

Allows grouping events into categories.

Registration

Information to describe some form of registration on a web site.

Event code: ibmregistration
Event attributes

Attribute Name

Data type

Example

Description

Required

eventName

string

Registration Activity

Name of the event as it appears in the Exchange user interface.

Yes

description

string

Description of the published event. Allow Exchange users to understand the event context.

interactionId

string

12345

Identify a site visit. Example: a cookie ID identifies the visitor. The interactionID identifies the visit. An individual can be involved in multiple visits. Also called a session ID.

Yes

registrationdate

string

2019-02-11T05

The date and time the registration was created or last updated.

Yes