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

Cart purchase – item

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

Event code: ibmcartPurchaseItem
Event attributes

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

Cart abandonment – item

Information that describes an individual item in an abandoned cart.

Event code: ibmcartAbandonmentItem
Event attributes

Conversion

Information that describes a conversion event.

Event code: ibmconversion
Event attributes

Abandoned conversion or non-conversion

Information that describes an abandoned conversion event.

Event code: ibmabandonedConversion
Event attributes

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

Product view

Information that describes a view of a web page.

Event code: ibmproductView
Event attributes

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

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

Video paused

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

Event code: ibmelementVideoPaused
Event attributes

Video completed

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

Event code: ibmelementVideoCompleted
Event attributes

Video launched

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

Event code: ibmelementVideoLaunched
Event attributes

Video completed

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

Event code: ibmelementVideoCompleted
Event attributes

Video launched

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

Event code: ibmelementVideoLaunched
Event attributes

Video played

Information that describes video being played by a customer.

Event code: ibmelementVideoPlayed
Event attributes

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

Entry page

Information that describes a customer visiting an entry page.

Event code: ibmpageviewEntryPage
Event attributes

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

Element

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

Event code: ibmelement
Event attributes

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

Registration

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

Event code: ibmregistration
Event attributes