# Analytics V1 Events

Deprecated

These events are deprecated. We recommend using updated Events for getting access to the new Dashboard features.

# Report & improve on actions

Report meaningful actions that occur during a customer journey which indicate an engaged customer.

Many actions can be used to improve the results for that customers' journey in both real-time and on return, some for improving results overall for all customers and other actions can be used for reporting.

Examples of meaningful actions for an e-commerce store might include:

add to collection - Whether a product has been added to cart, wishlist or other collections (and their name)
clicks - on both Visii generated recommendations and other product links
collection view (eg viewing wishlist) - this should include all items in wishlist, basket or purchase when viewed
filters - which filters the customer uses whilst searching
ratings (eg like, scoring)
scrolling events - important to limit rate of reporting by using milestones such as 25%, 50%, 75% and 100% of page viewed.
search inputs - any metadata that can be used to search and which results they subsequently click
split test group information - useful for reporting
time on page - important to limit rate of reporting by using milestones such as 1s, 5s, 10s, 30s, 1m

TIP

Every situation is unique, so we advise considering your use-case and success metrics, sending as much data as you feel comfortable whilst respecting PII data. Please contact us if you have any questions.

Tracking across journeys requires the use of the v querystring parameter across Vision API endpoints. To minimize additional requests, using the v parameter allows tracking without additional requests to this endpoint.

# Examples

# Exit

A user lands on a product page (id: aa-b1) - with a unique identifier of xxx123, used by the site to track users over multiple visits. This is generated or read from a cookie.
When requesting results, depending on where the results are rendered, two options are available:

Rendering Client-side: A request to Vision Similar is made with v variable is set to include the user id: /orgs/:org/datasets/:dataset/similar?id=aa-b1&v=u:xxx123&s:pdp
Rendering Server-side: Once the page is loaded with results, client-side request to track with action / a set to init will inform Visii of the user: /orgs/:org/datasets/:dataset/track?v=a:init,s:pdp,u:xxx123

The user clicks a Visii result. This is meaningful and part of the conversion funnel. A client or server side request to track with action exit with resultIndex set to the item they have chosen: /orgs/:org/datasets/:dataset/track?v=a:exit,s:pdp,u:xxx123,id:aa-b2

# Purchase

Continuing from above example - the user has been exited from another product page.

A user lands on a product page (id: aa-b2) - with the same user ID xxx123 which is read from a cookie.
The user adds the product to their cart. This is meaningful and part of the conversion funnel. A client or server side request to track with action set to add-cart: /orgs/:org/datasets/:dataset/track?v=a:add-cart,s:pdp,u:xxx123,id:aa-b2
At some point in the future, the user makes a purchase. This is meaningful as it is the end of the conversion funnel. A client or server side request to track with action set to add-cart: /orgs/:org/datasets/:dataset/track?v=a:purchase,u:xxx123,id:aa-b2

Body:

{
  "message": "purchase",
  "data": [
    {
      "id": "aa-b1",
      "value": 59.99,
      "currency": "EUR"
    },
    {
      "id": "xx-y1",
      "value": 24.99,
      "currency": "EUR"
    }
  ]
}

# UI Testing

Including information about the environment, widgets or behavior of a user can be used to see in reports and improve results.

The user scrolls through the paginated Visii results. This is meaningful as it suggests the first page of results are not suitable for them. A client-side request to track with action change-results and resultIndex set to the index of the first result they have paged in view: /orgs/:org/datasets/:dataset/track?v=a:change-results,s:pdp,u:xxx123&id:aa-b1,resultIndex:8
Two versions of a widget are being tested can be compared by providing a different source. A client-side request to track with source widget-a: /orgs/:org/datasets/:dataset/track?v=a:change-results,s:widget-a,u:xxx123,id:aa-b1